Pywikibot-commits March 2022

pywikibot-commits@lists.wikimedia.org

1 participants
162 discussions

[Gerrit] ...core[master]: add parameter type of bool based on the default value
by jenkins-bot (Code Review) 02 Mar '22

02 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767615 ) Change subject: add parameter type of bool based on the default value ...................................................................... add parameter type of bool based on the default value Change-Id: I71c8474594c273dcb22f5b6e6675d2d910350e5d --- M pywikibot/data/api.py M pywikibot/page/__init__.py M pywikibot/scripts/generate_user_files.py M pywikibot/site/_apisite.py M pywikibot/site/_basesite.py M pywikibot/site/_datasite.py M pywikibot/site/_extensions.py M pywikibot/site/_generators.py M pywikibot/site/_tokenwallet.py M pywikibot/textlib.py M pywikibot/throttle.py M pywikibot/titletranslate.py M pywikibot/tools/__init__.py M pywikibot/tools/djvu.py M pywikibot/version.py M pywikibot/xmlreader.py M scripts/archivebot.py M scripts/category.py M scripts/checkimages.py M scripts/interwiki.py M scripts/patrol.py M scripts/redirect.py M scripts/reflinks.py M scripts/solve_disambiguation.py M scripts/weblinkchecker.py M scripts/welcome.py 26 files changed, 335 insertions(+), 223 deletions(-) Approvals: JJMC89: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py index f362a0c..7c81237 100644 --- a/pywikibot/data/api.py +++ b/pywikibot/data/api.py @@ -93,7 +93,7 @@ """Workaround for bug in python 3 email handling of CTE binary.""" - def as_bytes(self, unixfrom=False, policy=None): + def as_bytes(self, unixfrom: bool = False, policy=None): """Return unmodified binary payload.""" policy = self.policy if policy is None else policy fp = BytesIO() @@ -2662,7 +2662,12 @@ """ - def __init__(self, generator: str, g_content=False, **kwargs) -> None: + def __init__( + self, + generator: str, + g_content: bool = False, + **kwargs + ) -> None: """ Initializer. diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index 15ea6ff..2fe45e3 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -263,10 +263,21 @@ self.site.loadpageinfo(self) return self._pageid - def title(self, *, underscore=False, with_ns=True, - with_section=True, as_url=False, as_link=False, - allow_interwiki=True, force_interwiki=False, textlink=False, - as_filename=False, insite=None, without_brackets=False) -> str: + def title( + self, + *, + underscore: bool = False, + with_ns: bool = True, + with_section: bool = True, + as_url: bool = False, + as_link: bool = False, + allow_interwiki: bool = True, + force_interwiki: bool = False, + textlink: bool = False, + as_filename: bool = False, + insite=None, + without_brackets: bool = False + ) -> str: """ Return the title of this Page, as a string. @@ -623,7 +634,7 @@ self._parsed_text = self.site.get_parsed_page(self) return self._parsed_text - def properties(self, force=False) -> dict: + def properties(self, force: bool = False) -> dict: """ Return the properties of the page. @@ -634,7 +645,7 @@ self.site.loadpageprops(self) return self._pageprops - def defaultsort(self, force=False) -> Optional[str]: + def defaultsort(self, force: bool = False) -> Optional[str]: """ Extract value of the {{DEFAULTSORT:}} magic word from the page. @@ -642,7 +653,11 @@ """ return self.properties(force=force).get('defaultsort') - def expand_text(self, force=False, includecomments=False) -> str: + def expand_text( + self, + force: bool = False, + includecomments: bool = False + ) -> str: """Return the page text with all templates and parser words expanded. :param force: force updating from the live site @@ -1221,8 +1236,8 @@ cc=apply_cosmetic_changes, quiet=quiet, **kwargs) @allow_asynchronous - def _save(self, summary=None, watch=None, minor=True, botflag=None, - cc=None, quiet=False, **kwargs): + def _save(self, summary=None, watch=None, minor: bool = True, botflag=None, + cc=None, quiet: bool = False, **kwargs): """Helper function for save().""" link = self.title(as_link=True) if cc or (cc is None and config.cosmetic_changes): @@ -1345,7 +1360,7 @@ self.clear_cache() return self.site.purgepages([self], **kwargs) - def touch(self, callback=None, botflag=False, **kwargs): + def touch(self, callback=None, botflag: bool = False, **kwargs): """ Make a touch edit for this page. @@ -1417,15 +1432,13 @@ return self.site.pagelinks(self, **kwargs) - def interwiki(self, expand=True): + def interwiki(self, expand: bool = True): """ Iterate interwiki links in the page text, excluding language links. :param expand: if True (default), include interwiki links found in templates transcluded onto this page; if False, only iterate interwiki links found in this page's own wikitext - :type expand: bool - :return: a generator that yields Link objects :rtype: generator """ @@ -1453,14 +1466,12 @@ # ignore any links with invalid contents continue - def langlinks(self, include_obsolete=False) -> list: + def langlinks(self, include_obsolete: bool = False) -> list: """ Return a list of all inter-language Links on this page. :param include_obsolete: if true, return even Link objects whose site is obsolete - :type include_obsolete: bool - :return: list of Link objects. """ # Note: We preload a list of *all* langlinks, including links to @@ -1580,7 +1591,7 @@ """ return self.site.page_extlinks(self, total=total) - def coordinates(self, primary_only=False): + def coordinates(self, primary_only: bool = False): """ Return a list of Coordinate objects for points on the page. @@ -1837,7 +1848,12 @@ self._deletedRevs[rev['timestamp']] = rev yield rev['timestamp'] - def getDeletedRevision(self, timestamp, content=False, **kwargs) -> List: + def getDeletedRevision( + self, + timestamp, + content: bool = False, + **kwargs + ) -> List: """ Return a particular deleted revision by timestamp. @@ -1860,12 +1876,11 @@ return item['revisions'][0] return [] - def markDeletedRevision(self, timestamp, undelete=True): + def markDeletedRevision(self, timestamp, undelete: bool = True): """ Mark the revision identified by timestamp for undeletion. :param undelete: if False, mark the revision to remain deleted. - :type undelete: bool """ if not hasattr(self, '_deletedRevs'): self.loadDeletedRevisions() @@ -2167,8 +2182,15 @@ result.append((pywikibot.Page(link, self.site), positional)) return result - def set_redirect_target(self, target_page, create=False, force=False, - keep_section=False, save=True, **kwargs): + def set_redirect_target( + self, + target_page, + create: bool = False, + force: bool = False, + keep_section: bool = False, + save: bool = True, + **kwargs + ): """ Change the page's text to point to the redirect page. @@ -2176,15 +2198,11 @@ :type target_page: pywikibot.Page or string :param create: if true, it creates the redirect even if the page doesn't exist. - :type create: bool :param force: if true, it set the redirect target even the page doesn't exist or it's not redirect. - :type force: bool :param keep_section: if the old redirect links to a section and the new one doesn't it uses the old redirect's section. - :type keep_section: bool :param save: if true, it saves the page immediately. - :type save: bool :param kwargs: Arguments which are used for saving the page directly afterwards, like 'summary' for edit summary. """ @@ -2717,7 +2735,7 @@ def members(self, recurse: bool = False, namespaces=None, total: Optional[int] = None, - content=False): + content: bool = False): """Yield all category contents (subcats, pages, and files). :rtype: typing.Iterable[pywikibot.Page] @@ -2913,13 +2931,11 @@ self._userprops['blockreason'] = r[0]['reason'] return self._userprops - def registration(self, force=False): + def registration(self, force: bool = False): """ Fetch registration date for this user. :param force: if True, forces reloading the data from API - :type force: bool - :rtype: pywikibot.Timestamp or None """ if not self.isAnonymous(): @@ -3326,12 +3342,11 @@ params['ids'] = self.id return params - def getID(self, numeric=False): + def getID(self, numeric: bool = False): """ Get the identifier of this entity. :param numeric: Strip the first letter and return an int - :type numeric: bool """ if numeric: return int(self.id[1:]) if self.id != '-1' else -1 @@ -3552,12 +3567,11 @@ return super().get(force=force) - def getID(self, numeric=False): + def getID(self, numeric: bool = False): """ Get the entity identifier. :param numeric: Strip the first letter and return an int - :type numeric: bool """ if self.id == '-1': self.get() @@ -3823,8 +3837,15 @@ data = {'aliases': aliases} self.editEntity(data, **kwargs) - def set_redirect_target(self, target_page, create=False, force=False, - keep_section=False, save=True, **kwargs): + def set_redirect_target( + self, + target_page, + create: bool = False, + force: bool = False, + keep_section: bool = False, + save: bool = True, + **kwargs + ): """ Set target of a redirect for a Wikibase page. @@ -3833,14 +3854,13 @@ raise NotImplementedError @allow_asynchronous - def addClaim(self, claim, bot=True, **kwargs): + def addClaim(self, claim, bot: bool = True, **kwargs): """ Add a claim to the entity. :param claim: The claim to add :type claim: pywikibot.page.Claim :param bot: Whether to flag as bot (if possible) - :type bot: bool :keyword asynchronous: if True, launch a separate thread to add claim asynchronously :type asynchronous: bool @@ -4011,21 +4031,19 @@ return super().title(**kwargs) - def getID(self, numeric=False, force=False): + def getID(self, numeric: bool = False, force: bool = False): """ Get the entity identifier. :param numeric: Strip the first letter and return an int - :type numeric: bool :param force: Force an update of new data - :type force: bool """ if not hasattr(self, 'id') or force: self.get(force=force) return super().getID(numeric=numeric) @classmethod - def fromPage(cls, page, lazy_load=False): + def fromPage(cls, page, lazy_load: bool = False): """ Get the ItemPage for a Page that links to it. @@ -4033,7 +4051,6 @@ :type page: pywikibot.page.Page :param lazy_load: Do not raise NoPageError if either page or corresponding ItemPage does not exist. - :type lazy_load: bool :rtype: pywikibot.page.ItemPage :raise pywikibot.exceptions.NoPageError: There is no corresponding @@ -4099,15 +4116,19 @@ return item - def get(self, force=False, get_redirect=False, *args, **kwargs) -> dict: + def get( + self, + force: bool = False, + get_redirect: bool = False, + *args, + **kwargs + ) -> Dict[str, Any]: """ Fetch all item data, and cache it. :param force: override caching - :type force: bool :param get_redirect: return the item content, do not follow the redirect, do not raise an exception. - :type get_redirect: bool :raise NotImplementedError: a value in args or kwargs :return: actual data which entity holds :note: dicts returned by this method are references to content of this @@ -4151,7 +4172,7 @@ pg._item = self yield pg - def getSitelink(self, site, force=False) -> str: + def getSitelink(self, site, force: bool = False) -> str: """ Return the title for the specific site. @@ -4226,8 +4247,15 @@ self._isredir = True self._redirtarget = item - def set_redirect_target(self, target_page, create=False, force=False, - keep_section=False, save=True, **kwargs): + def set_redirect_target( + self, + target_page, + create: bool = False, + force: bool = False, + keep_section: bool = False, + save: bool = True, + **kwargs + ): """ Make the item redirect to another item. @@ -4237,7 +4265,6 @@ :type target_page: pywikibot.page.ItemPage or string :param force: if true, it sets the redirect target even the page is not redirect. - :type force: bool """ if isinstance(target_page, str): target_page = pywikibot.ItemPage(self.repo, target_page) @@ -4328,12 +4355,11 @@ self._type = self.repo.getPropertyType(self) return self._type - def getID(self, numeric=False): + def getID(self, numeric: bool = False): """ Get the identifier of this property. :param numeric: Strip the first letter and return an int - :type numeric: bool """ if numeric: return int(self.id[1:]) @@ -4425,12 +4451,11 @@ return Claim(self.site, self.getID(), datatype=self.type, *args, **kwargs) - def getID(self, numeric=False): + def getID(self, numeric: bool = False): """ Get the identifier of this property. :param numeric: Strip the first letter and return an int - :type numeric: bool """ # enforce this parent's implementation return WikibasePage.getID(self, numeric=numeric) @@ -4470,8 +4495,17 @@ SNAK_TYPES = ('value', 'somevalue', 'novalue') - def __init__(self, site, pid, snak=None, hash=None, is_reference=False, - is_qualifier=False, rank: str = 'normal', **kwargs) -> None: + def __init__( + self, + site, + pid, + snak=None, + hash=None, + is_reference: bool = False, + is_qualifier: bool = False, + rank: str = 'normal', + **kwargs + ) -> None: """ Initializer. @@ -4546,8 +4580,13 @@ return False return True - def same_as(self, other, ignore_rank=True, ignore_quals=False, - ignore_refs=True) -> bool: + def same_as( + self, + other, + ignore_rank: bool = True, + ignore_quals: bool = False, + ignore_refs: bool = True + ) -> bool: """Check if two claims are same.""" if ignore_rank: attributes = ['id', 'snaktype', 'target'] diff --git a/pywikibot/scripts/generate_user_files.py b/pywikibot/scripts/generate_user_files.py index b4c09c9..7924328 100755 --- a/pywikibot/scripts/generate_user_files.py +++ b/pywikibot/scripts/generate_user_files.py @@ -100,9 +100,12 @@ return False -def get_site_and_lang(default_family: Optional[str] = 'wikipedia', - default_lang: Optional[str] = 'en', - default_username: Optional[str] = None, force=False): +def get_site_and_lang( + default_family: Optional[str] = 'wikipedia', + default_lang: Optional[str] = 'en', + default_username: Optional[str] = None, + force: bool = False +): """ Ask the user for the family, site code and username. @@ -264,7 +267,12 @@ return ''.join(result) -def create_user_config(main_family, main_code, main_username, force=False): +def create_user_config( + main_family, + main_code, + main_username, + force: bool = False +): """ Create a user-config.py in base_dir. diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 8ca21bd..851ca9d 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -594,7 +594,7 @@ """ return 'locked' in self.get_globaluserinfo(user, force) - def get_searched_namespaces(self, force=False): + def get_searched_namespaces(self, force: bool = False): """ Retrieve the default searched namespaces for the user. @@ -651,8 +651,8 @@ return path.replace('$1', '{}') @staticmethod - def assert_valid_iter_params(msg_prefix, start, end, reverse, - is_ts=True) -> None: + def assert_valid_iter_params(msg_prefix, start, end, reverse: bool, + is_ts: bool = True) -> None: """Validate iterating API parameters. :param msg_prefix: The calling method name @@ -660,10 +660,8 @@ :param start: The start value to compare :param end: The end value to compare :param reverse: The reverse option - :type reverse: bool :param is_ts: When comparing timestamps (with is_ts=True) the start is usually greater than end. Comparing titles this is vice versa. - :type is_ts: bool :raises AssertionError: start/end values are in wrong order """ if reverse ^ is_ts: @@ -1127,14 +1125,13 @@ # 'title' is expected to be URL-encoded already return self.siteinfo['articlepath'].replace('$1', title) - def namespace(self, num, all=False): + def namespace(self, num: int, all: bool = False): """Return string containing local name of namespace 'num'. If optional argument 'all' is true, return all recognized values for this namespace. :param num: Namespace constant. - :type num: int :param all: If True return a Namespace object. Otherwise return the namespace name. :return: local name or Namespace object @@ -1168,7 +1165,7 @@ raise PageRelatedError( page, 'loadimageinfo: Query on {} returned no imageinfo') - def loadpageinfo(self, page, preload=False) -> None: + def loadpageinfo(self, page, preload: bool = False) -> None: """Load page info from api and store in page attributes. :see: https://www.mediawiki.org/wiki/API:Info @@ -1193,7 +1190,7 @@ ) self._update_page(page, query) - def loadimageinfo(self, page, history=False, + def loadimageinfo(self, page, history: bool = False, url_width=None, url_height=None, url_param=None) -> None: """Load image info from api and save in page attributes. @@ -1590,9 +1587,19 @@ _ep_text_overrides = {'appendtext', 'prependtext', 'undo'} @need_right('edit') - def editpage(self, page, summary=None, minor=True, notminor=False, - bot=True, recreate=True, createonly=False, nocreate=False, - watch=None, **kwargs) -> bool: + def editpage( + self, + page, + summary=None, + minor: bool = True, + notminor: bool = False, + bot: bool = True, + recreate: bool = True, + createonly: bool = False, + nocreate: bool = False, + watch=None, + **kwargs + ) -> bool: """Submit an edit to be saved to the wiki. :see: https://www.mediawiki.org/wiki/API:Edit @@ -1934,8 +1941,8 @@ } @need_right('move') - def movepage(self, page, newtitle: str, summary, movetalk=True, - noredirect=False): + def movepage(self, page, newtitle: str, summary, movetalk: bool = True, + noredirect: bool = False): """Move a Page to a new title. :see: https://www.mediawiki.org/wiki/API:Move @@ -2324,9 +2331,18 @@ # TODO: implement undelete @need_right('block') - def blockuser(self, user, expiry, reason: str, anononly=True, - nocreate=True, autoblock=True, noemail=False, - reblock=False, allowusertalk=False): + def blockuser( + self, + user, + expiry, + reason: str, + anononly: bool = True, + nocreate: bool = True, + autoblock: bool = True, + noemail: bool = False, + reblock: bool = False, + allowusertalk: bool = False + ): """ Block a user for certain amount of time and for a certain reason. @@ -2350,20 +2366,14 @@ str (relative/absolute) or False ('never') :param reason: The reason for the block. :param anononly: Disable anonymous edits for this IP. - :type anononly: boolean :param nocreate: Prevent account creation. - :type nocreate: boolean :param autoblock: Automatically block the last used IP address and all subsequent IP addresses from which this account logs in. - :type autoblock: boolean :param noemail: Prevent user from sending email through the wiki. - :type noemail: boolean :param reblock: If the user is already blocked, overwrite the existing block. - :type reblock: boolean :param allowusertalk: Whether the user can edit their talk page while blocked. - :type allowusertalk: boolean :return: The data retrieved from the API request. :rtype: dict """ diff --git a/pywikibot/site/_basesite.py b/pywikibot/site/_basesite.py index c2a02f9..19f3250 100644 --- a/pywikibot/site/_basesite.py +++ b/pywikibot/site/_basesite.py @@ -230,7 +230,7 @@ return [lang for lang in self.languages() if self.namespaces.lookup_normalized_name(lang) is None] - def _interwiki_urls(self, only_article_suffixes=False): + def _interwiki_urls(self, only_article_suffixes: bool = False): base_path = self.path() if not only_article_suffixes: yield base_path + '{}' @@ -272,7 +272,7 @@ """Return list of localized PAGENAMEE tags for the site.""" return ['PAGENAMEE'] - def lock_page(self, page, block=True): + def lock_page(self, page, block: bool = True): """ Lock page for writing. Must be called before writing any page. diff --git a/pywikibot/site/_datasite.py b/pywikibot/site/_datasite.py index 5c2c62f..f5c8a2a 100644 --- a/pywikibot/site/_datasite.py +++ b/pywikibot/site/_datasite.py @@ -244,7 +244,7 @@ return dtype @need_right('edit') - def editEntity(self, entity, data, bot=True, **kwargs): + def editEntity(self, entity, data, bot: bool = True, **kwargs): """ Edit entity. @@ -257,7 +257,6 @@ :param data: data updates :type data: dict :param bot: Whether to mark the edit as a bot edit - :type bot: bool :return: New entity data :rtype: dict """ @@ -297,7 +296,7 @@ return req.submit() @need_right('edit') - def addClaim(self, entity, claim, bot=True, summary=None) -> None: + def addClaim(self, entity, claim, bot: bool = True, summary=None) -> None: """ Add a claim. @@ -306,7 +305,6 @@ :param claim: Claim to be added :type claim: pywikibot.Claim :param bot: Whether to mark the edit as a bot edit - :type bot: bool :param summary: Edit summary :type summary: str """ @@ -329,7 +327,7 @@ @need_right('edit') def changeClaimTarget(self, claim, snaktype: str = 'value', - bot=True, summary=None): + bot: bool = True, summary=None): """ Set the claim target to the value of the provided claim target. @@ -338,7 +336,6 @@ :param snaktype: An optional snaktype ('value', 'novalue' or 'somevalue'). Default: 'value' :param bot: Whether to mark the edit as a bot edit - :type bot: bool :param summary: Edit summary :type summary: str """ @@ -359,14 +356,13 @@ return req.submit() @need_right('edit') - def save_claim(self, claim, summary=None, bot=True): + def save_claim(self, claim, summary=None, bot: bool = True): """ Save the whole claim to the wikibase site. :param claim: The claim to save :type claim: pywikibot.Claim :param bot: Whether to mark the edit as a bot edit - :type bot: bool :param summary: Edit summary :type summary: str """ @@ -573,7 +569,7 @@ return req.submit() @need_right('edit') - def linkTitles(self, page1, page2, bot=True): + def linkTitles(self, page1, page2, bot: bool = True): """ Link two pages together. @@ -582,7 +578,6 @@ :param page2: Second page to link :type page2: pywikibot.Page :param bot: Whether to mark the edit as a bot edit - :type bot: bool :return: dict API output :rtype: dict """ @@ -601,7 +596,7 @@ @need_right('item-merge') def mergeItems(self, from_item, to_item, ignore_conflicts=None, - summary=None, bot=True): + summary=None, bot: bool = True): """ Merge two items together. @@ -616,7 +611,6 @@ :param summary: Edit summary :type summary: str :param bot: Whether to mark the edit as a bot edit - :type bot: bool :return: dict API output :rtype: dict """ @@ -634,7 +628,7 @@ return req.submit() @need_right('item-redirect') - def set_redirect_target(self, from_item, to_item, bot=True): + def set_redirect_target(self, from_item, to_item, bot: bool = True): """ Make a redirect to another item. @@ -643,7 +637,6 @@ :param from_item: Title of the item to be redirected. :type from_item: pywikibot.ItemPage :param bot: Whether to mark the edit as a bot edit - :type bot: bool """ params = { 'action': 'wbcreateredirect', diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py index 63b8df3..ed7b597 100644 --- a/pywikibot/site/_extensions.py +++ b/pywikibot/site/_extensions.py @@ -375,11 +375,11 @@ content_format: str = 'wikitext', limit: int = 100, sortby: str = 'newest', - toconly=False, + toconly: bool = False, offset=None, offset_id=None, - reverse=False, - include_offset=False + reverse: bool = False, + include_offset: bool = False ): """ Retrieve the topiclist of a Flow board. diff --git a/pywikibot/site/_generators.py b/pywikibot/site/_generators.py index 5605f22..f8ab2ad 100644 --- a/pywikibot/site/_generators.py +++ b/pywikibot/site/_generators.py @@ -94,8 +94,15 @@ priority, page = heapq.heappop(prio_queue) yield page - def preloadpages(self, pagelist, *, groupsize: int = 50, templates=False, - langlinks=False, pageprops=False): + def preloadpages( + self, + pagelist, + *, + groupsize: int = 50, + templates: bool = False, + langlinks: bool = False, + pageprops: bool = False + ): """Return a generator to a list of preloaded pages. Pages are iterated in the same order than in the underlying pagelist. @@ -103,16 +110,11 @@ :param pagelist: an iterable that returns Page objects :param groupsize: how many Pages to query at a time - :type groupsize: int :param templates: preload pages (typically templates) transcluded in the provided pages - :type templates: bool :param langlinks: preload all language links from the provided pages to other languages - :type langlinks: bool :param pageprops: preload various properties defined in page content - :type pageprops: bool - """ props = 'revisions|info|categoryinfo' if templates: @@ -194,9 +196,9 @@ priority, page = heapq.heappop(prio_queue) yield page - def pagebacklinks(self, page, *, follow_redirects=False, + def pagebacklinks(self, page, *, follow_redirects: bool = False, filter_redirects=None, namespaces=None, total=None, - content=False): + content: bool = False): """Iterate all pages that link to the given page. :see: https://www.mediawiki.org/wiki/API:Backlinks @@ -258,7 +260,7 @@ return blgen def page_embeddedin(self, page, *, filter_redirects=None, namespaces=None, - total=None, content=False): + total=None, content: bool = False): """Iterate all pages that embedded the given page as a template. :see: https://www.mediawiki.org/wiki/API:Embeddedin @@ -321,10 +323,17 @@ namespaces=namespaces, total=total, g_content=content, **rdargs) - def pagereferences(self, page, *, follow_redirects=False, - filter_redirects=None, with_template_inclusion=True, - only_template_inclusion=False, namespaces=None, - total=None, content=False): + def pagereferences( + self, + page, *, + follow_redirects: bool = False, + filter_redirects=None, + with_template_inclusion: bool = True, + only_template_inclusion: bool = False, + namespaces=None, + total=None, + content: bool = False + ): """ Convenience method combining pagebacklinks and page_embeddedin. @@ -395,7 +404,7 @@ **plargs) # Sortkey doesn't work with generator - def pagecategories(self, page, *, total=None, content=False): + def pagecategories(self, page, *, total=None, content: bool = False): """Iterate categories to which page belongs. :see: https://www.mediawiki.org/wiki/API:Categories @@ -414,7 +423,7 @@ type_arg='categories', total=total, g_content=content, **clargs) - def pageimages(self, page, *, total=None, content=False): + def pageimages(self, page, *, total=None, content: bool = False): """Iterate images used (not just linked) on the page. :see: https://www.mediawiki.org/wiki/API:Images @@ -430,7 +439,7 @@ g_content=content) def pagetemplates(self, page, *, namespaces=None, total=None, - content=False): + content: bool = False): """Iterate templates transcluded (not just linked) on the page. :see: https://www.mediawiki.org/wiki/API:Templates @@ -611,7 +620,14 @@ props.append('roles') return props - def loadrevisions(self, page, *, content=False, section=None, **kwargs): + def loadrevisions( + self, + page, + *, + content: bool = False, + section=None, + **kwargs + ): """Retrieve revision information and store it in page object. By default, retrieves the last (current) revision of the page, @@ -630,7 +646,6 @@ :type page: pywikibot.Page :param content: if True, retrieve the wiki-text of each revision; otherwise, only retrieve the revision metadata (default) - :type content: bool :param section: if specified, retrieve only this section of the text (content must be True); section must be given by number (top of the article is section 0), not name @@ -802,9 +817,9 @@ maxsize=None, protect_type=None, protect_level=None, - reverse=False, + reverse: bool = False, total=None, - content=False + content: bool = False ): """Iterate pages in a single namespace. @@ -879,8 +894,8 @@ start: str = '!', prefix: str = '', namespace=0, - unique=False, - fromids=False, + unique: bool = False, + fromids: bool = False, total=None ): """Iterate all links to pages (which need not exist) in one namespace. @@ -920,7 +935,7 @@ yield p def allcategories(self, start: str = '!', prefix: str = '', total=None, - reverse=False, content=False): + reverse: bool = False, content: bool = False): """Iterate categories used (which need not have a Category page). Iterator yields Category objects. Note that, in practice, links that @@ -1000,11 +1015,11 @@ prefix: str = '', minsize=None, maxsize=None, - reverse=False, + reverse: bool = False, sha1=None, sha1base36=None, total=None, - content=False + content: bool = False ): """Iterate all images, ordered by image title. @@ -1041,8 +1056,14 @@ aigen.request['gaisha1base36'] = sha1base36 return aigen - def filearchive(self, start=None, end=None, reverse=False, total=None, - **kwargs): + def filearchive( + self, + start=None, + end=None, + reverse: bool = False, + total=None, + **kwargs + ): """Iterate archived files. Yields dict of file archive informations. @@ -1072,7 +1093,7 @@ fagen.request['fadir'] = 'descending' return fagen - def blocks(self, starttime=None, endtime=None, reverse=False, + def blocks(self, starttime=None, endtime=None, reverse: bool = False, blockids=None, users=None, iprange: Optional[str] = None, total: Optional[int] = None): """Iterate all current blocks, in order of creation. @@ -1091,7 +1112,6 @@ :param endtime: stop iterating at this Timestamp :type endtime: pywikibot.Timestamp :param reverse: if True, iterate oldest blocks first (default: newest) - :type reverse: bool :param blockids: only iterate blocks with these id numbers. Numbers must be separated by '|' if given by a str. :type blockids: str, tuple or list @@ -1131,7 +1151,7 @@ def exturlusage(self, url: Optional[str] = None, protocol: Optional[str] = None, namespaces=None, - total: Optional[int] = None, content=False): + total: Optional[int] = None, content: bool = False): """Iterate Pages that contain links to the given URL. :see: https://www.mediawiki.org/wiki/API:Exturlusage @@ -1168,7 +1188,7 @@ total=total, g_content=content) def imageusage(self, image, namespaces=None, filterredir=None, - total=None, content=False): + total=None, content: bool = False): """Iterate Pages that contain links to the given FilePage. :see: https://www.mediawiki.org/wiki/API:Imageusage @@ -1387,8 +1407,8 @@ return srgen def usercontribs(self, user=None, userprefix=None, start=None, end=None, - reverse=False, namespaces=None, minor=None, - total: Optional[int] = None, top_only=False): + reverse: bool = False, namespaces=None, minor=None, + total: Optional[int] = None, top_only: bool = False): """Iterate contributions by a particular user. Iterated values are in the same format as recentchanges. @@ -1442,7 +1462,7 @@ ucgen.request['ucshow'] = option_set return ucgen - def watchlist_revs(self, start=None, end=None, reverse=False, + def watchlist_revs(self, start=None, end=None, reverse: bool = False, namespaces=None, minor=None, bot=None, anon=None, total=None): """Iterate revisions to pages on the bot user's watchlist. @@ -1508,7 +1528,7 @@ def deletedrevs(self, titles=None, start=None, end=None, reverse: bool = False, - content=False, total=None, **kwargs): + content: bool = False, total=None, **kwargs): """Iterate deleted revisions. Each value returned by the iterator will be a dict containing the @@ -1685,7 +1705,7 @@ return usgen def randompages(self, total=None, namespaces=None, - redirects=False, content=False): + redirects: Optional[bool] = False, content: bool = False): """Iterate a number of random pages. :see: https://www.mediawiki.org/wiki/API:Random @@ -1701,7 +1721,6 @@ :param redirects: if True, include only redirect pages in results, False does not include redirects and None (MW 1.26+) include both types. (default: False) - :type redirects: bool or None :param content: if True, load the current content of each iterated page (default False) :raises KeyError: a namespace identifier was not resolved @@ -1821,10 +1840,20 @@ yield result['patrol'] - def newpages(self, user=None, returndict=False, - start=None, end=None, reverse=False, bot=False, - redirect=False, excludeuser=None, - patrolled=None, namespaces=None, total=None): + def newpages( + self, + user=None, + returndict: bool = False, + start=None, + end=None, + reverse: bool = False, + bot: bool = False, + redirect: bool = False, + excludeuser=None, + patrolled=None, + namespaces=None, + total=None + ): """Yield new articles (as Page objects) from recent changes. Starts with the newest article and fetches the number of articles @@ -2046,8 +2075,13 @@ """ return self.querypage('Listredirects', total) - def protectedpages(self, namespace=0, type: str = 'edit', level=False, - total=None): + def protectedpages( + self, + namespace=0, + type: str = 'edit', + level: Union[str, bool] = False, + total=None + ): """ Return protected pages depending on protection level and type. @@ -2063,7 +2097,6 @@ :type type: str :param level: The protection level (like 'autoconfirmed'). If False it shows all protection levels. - :type level: str or False :return: The pages which are protected. :rtype: typing.Iterable[pywikibot.Page] """ @@ -2095,14 +2128,13 @@ return self._generator(api.PageGenerator, type_arg='pageswithprop', gpwppropname=propname, total=total) - def watched_pages(self, force=False, total=None): + def watched_pages(self, force: bool = False, total=None): """ Return watchlist. :see: https://www.mediawiki.org/wiki/API:Watchlistraw :param force: Reload watchlist - :type force: bool :param total: if not None, limit the generator to yielding this many items in total :type total: int diff --git a/pywikibot/site/_tokenwallet.py b/pywikibot/site/_tokenwallet.py index fd49f32..12bd1a3 100644 --- a/pywikibot/site/_tokenwallet.py +++ b/pywikibot/site/_tokenwallet.py @@ -24,7 +24,7 @@ self._tokens = {} self.failed_cache = set() # cache unavailable tokens. - def load_tokens(self, types, all=False) -> None: + def load_tokens(self, types, all: bool = False) -> None: """ Preload one or multiple tokens. @@ -32,7 +32,6 @@ :type types: iterable :param all: load all available tokens, if None only if it can be done in one request. - :type all: bool """ if self.site.user() is None: self.site.login() diff --git a/pywikibot/textlib.py b/pywikibot/textlib.py index 8f4b566..d033913 100644 --- a/pywikibot/textlib.py +++ b/pywikibot/textlib.py @@ -19,7 +19,7 @@ from typing import NamedTuple, Optional, Union import pywikibot -from pywikibot.backports import Container, Iterable, List +from pywikibot.backports import Container, Dict, Iterable, List from pywikibot.backports import OrderedDict as OrderedDictType from pywikibot.backports import Sequence as SequenceType from pywikibot.backports import Tuple @@ -1006,7 +1006,11 @@ # do not find or change links of other kinds, nor any that are formatted # as in-line interwiki links (e.g., "[[:es:Artículo]]". -def getLanguageLinks(text: str, insite=None, template_subpage=False) -> dict: +def getLanguageLinks( + text: str, + insite=None, + template_subpage: bool = False +) -> Dict: """ Return a dict of inter-language links found in text. @@ -1601,7 +1605,7 @@ # Functions dealing with external links # ------------------------------------- -def compileLinkR(withoutBracketed=False, onlyBracketed: bool = False): +def compileLinkR(withoutBracketed: bool = False, onlyBracketed: bool = False): """Return a regex that matches external links.""" # RFC 2396 says that URLs may only contain certain characters. # For this regex we also accept non-allowed characters, so that the bot diff --git a/pywikibot/throttle.py b/pywikibot/throttle.py index a77ec52..7079d1a 100644 --- a/pywikibot/throttle.py +++ b/pywikibot/throttle.py @@ -111,7 +111,7 @@ hashobj = md5(module) return hashobj.hexdigest()[:4] # slice for Python 3.5 - def _read_file(self, raise_exc=False): + def _read_file(self, raise_exc: bool = False): """Yield process entries from file.""" try: with open(self.ctrlfilename) as f: @@ -197,7 +197,12 @@ pywikibot.log('Found {} {} processes running, including this one.' .format(count, mysite)) - def setDelays(self, delay=None, writedelay=None, absolute=False) -> None: + def setDelays( + self, + delay=None, + writedelay=None, + absolute: bool = False + ) -> None: """Set the nominal delays in seconds. Defaults to config values.""" with self.lock: delay = delay or self.mindelay @@ -211,7 +216,7 @@ # Start the delay count now, not at the next check self.last_read = self.last_write = time.time() - def getDelay(self, write=False): + def getDelay(self, write: bool = False): """Return the actual delay, accounting for multiple processes. This value is the maximum wait between reads/writes, not taking @@ -234,7 +239,7 @@ thisdelay *= self.process_multiplicity return thisdelay - def waittime(self, write=False): + def waittime(self, write: bool = False): """Return waiting time in seconds. The result is for a query that would be made right now. @@ -277,7 +282,7 @@ time.sleep(seconds) - def __call__(self, requestsize: int = 1, write=False) -> None: + def __call__(self, requestsize: int = 1, write: bool = False) -> None: """Block the calling program if the throttle time has not expired. Parameter requestsize is the number of Pages to be read/written; diff --git a/pywikibot/titletranslate.py b/pywikibot/titletranslate.py index 9812ff6..1e70a00 100644 --- a/pywikibot/titletranslate.py +++ b/pywikibot/titletranslate.py @@ -6,10 +6,16 @@ # import pywikibot from pywikibot import config, date +from pywikibot.backports import List -def translate(page=None, hints=(), auto=True, removebrackets=False, - site=None) -> list: +def translate( + page=None, + hints=(), + auto: bool = True, + removebrackets: bool = False, + site=None +) -> List['pywikibot.Link']: """ Return a list of links to pages on other sites based on hints. diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index a5367f8..61e7046 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -1108,7 +1108,7 @@ return result -def open_archive(filename, mode: str = 'rb', use_extension=True): +def open_archive(filename: str, mode: str = 'rb', use_extension: bool = True): """ Open a file and uncompress it if needed. @@ -1123,11 +1123,9 @@ .. versionadded:: 3.0 :param filename: The filename. - :type filename: str :param use_extension: Use the file extension instead of the magic number to determine the type of compression (default True). Must be True when writing or appending. - :type use_extension: bool :param mode: The mode in which the file should be opened. It may either be 'r', 'rb', 'a', 'ab', 'w' or 'wb'. All modes open the file in binary mode. It defaults to 'rb'. @@ -1241,8 +1239,8 @@ def file_mode_checker( filename: str, mode: int = 0o600, - quiet=False, - create=False + quiet: bool = False, + create: bool = False ): """Check file mode and update it, if needed. @@ -1251,9 +1249,7 @@ :param filename: filename path :param mode: requested file mode :param quiet: warn about file mode change if False. - :type quiet: bool :param create: create the file if it does not exist already - :type create: bool :raise IOError: The file does not exist and `create` is False. """ try: diff --git a/pywikibot/tools/djvu.py b/pywikibot/tools/djvu.py index debb78e..c657df0 100644 --- a/pywikibot/tools/djvu.py +++ b/pywikibot/tools/djvu.py @@ -113,12 +113,11 @@ return wrapper @check_cache - def number_of_images(self, force=False): + def number_of_images(self, force: bool = False): """ Return the number of images in the djvu file. :param force: if True, refresh the cached data - :type force: bool """ if not hasattr(self, '_page_count'): res, stdoutdata = _call_cmd(['djvused', '-e', 'n', self.file]) @@ -128,26 +127,23 @@ return self._page_count @check_page_number - def page_info(self, n, force=False): + def page_info(self, n: int, force: bool = False): """ Return a tuple (id, (size, dpi)) for page n of djvu file. :param n: page n of djvu file - :type n: int :param force: if True, refresh the cached data - :type force: bool """ if not hasattr(self, '_page_info') or force: self._get_page_info(force=force) return self._page_info[n] @check_cache - def _get_page_info(self, force=False): + def _get_page_info(self, force: bool = False): """ Return a dict of tuples (id, (size, dpi)) for all pages of djvu file. :param force: if True, refresh the cached data - :type force: bool """ if not hasattr(self, '_page_info'): self._page_info = {} @@ -190,12 +186,11 @@ return size, dpi @check_cache - def has_text(self, force=False): + def has_text(self, force: bool = False): """ Test if the djvu file has a text-layer. :param force: if True, refresh the cached data - :type force: bool """ if not hasattr(self, '_has_text'): self._get_page_info(force=force) @@ -221,14 +216,12 @@ @check_page_number @check_cache - def get_page(self, n, force=False): + def get_page(self, n: int, force: bool = False): """ Get page n for djvu file. :param n: page n of djvu file - :type n: int :param force: if True, refresh the cached data - :type force: bool """ if not self.has_text(force=force): raise ValueError('Djvu file {} has no text layer.' diff --git a/pywikibot/version.py b/pywikibot/version.py index a84a536..fa621fb 100644 --- a/pywikibot/version.py +++ b/pywikibot/version.py @@ -22,7 +22,7 @@ import pywikibot from pywikibot import config -from pywikibot.backports import cache +from pywikibot.backports import List, cache from pywikibot.comms.http import fetch from pywikibot.exceptions import VersionParseError @@ -379,18 +379,19 @@ return None -def package_versions(modules=None, builtins=False, standard_lib=None): +def package_versions( + modules: Optional[List[str]] = None, + builtins: Optional[bool] = False, + standard_lib: Optional[bool] = None +): """Retrieve package version information. When builtins or standard_lib are None, they will be included only if a version was found in the package. :param modules: Modules to inspect - :type modules: list of strings :param builtins: Include builtins - :type builtins: Boolean, or None for automatic selection :param standard_lib: Include standard library packages - :type standard_lib: Boolean, or None for automatic selection """ if not modules: modules = sys.modules.keys() diff --git a/pywikibot/xmlreader.py b/pywikibot/xmlreader.py index 9b57a19..2a5bb3c 100644 --- a/pywikibot/xmlreader.py +++ b/pywikibot/xmlreader.py @@ -102,7 +102,7 @@ Default: False. """ - def __init__(self, filename, allrevisions=False) -> None: + def __init__(self, filename, allrevisions: bool = False) -> None: """Initializer.""" self.filename = filename if allrevisions: diff --git a/scripts/archivebot.py b/scripts/archivebot.py index 411e430..04e365b 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -492,7 +492,7 @@ return len(self.header.encode('utf-8')) + sum(t.size() for t in self.threads) - def update(self, summary, sort_threads=False) -> None: + def update(self, summary, sort_threads: bool = False) -> None: """Recombine threads and save page.""" if sort_threads: pywikibot.output('Sorting threads...') @@ -558,7 +558,7 @@ """Get an archiver attribute.""" return self.attributes.get(attr, [default])[0] - def set_attr(self, attr, value, out=True) -> None: + def set_attr(self, attr, value, out: bool = True) -> None: """Set an archiver attribute.""" if attr == 'archive': value = value.replace('_', ' ') diff --git a/scripts/category.py b/scripts/category.py index eb69f9b..e5c13ef 100755 --- a/scripts/category.py +++ b/scripts/category.py @@ -187,8 +187,13 @@ """A class to prepare a list of pages for robots.""" - def __init__(self, follow_redirects=False, edit_redirects=False, - create=False, **kwargs) -> None: + def __init__( + self, + follow_redirects: bool = False, + edit_redirects: bool = False, + create: bool = False, + **kwargs + ) -> None: """Initializer.""" super().__init__(**kwargs) self.follow_redirects = follow_redirects @@ -305,7 +310,7 @@ def __init__( self, - rebuild=False, + rebuild: bool = False, filename: str = 'category.dump.bz2' ) -> None: """Initializer.""" @@ -833,7 +838,7 @@ self.newcat.text = self.oldcat.text self._strip_cfd_templates(summary) - def _strip_cfd_templates(self, summary=None, commit=True) -> None: + def _strip_cfd_templates(self, summary=None, commit: bool = True) -> None: """Private function to strip out CFD templates from the new category. The new category is saved. diff --git a/scripts/checkimages.py b/scripts/checkimages.py index d097449..62d4363 100755 --- a/scripts/checkimages.py +++ b/scripts/checkimages.py @@ -510,9 +510,9 @@ self, site, log_full_number: int = 25000, - sendemail_active=False, - duplicates_report=False, - log_full_error=True, + sendemail_active: bool = False, + duplicates_report: bool = False, + log_full_error: bool = True, max_user_notify=None ) -> None: """Initializer, define some instance variables.""" @@ -571,9 +571,17 @@ self.timestamp = None self.uploader = None - def report(self, newtext, image_to_report, notification=None, head=None, - notification2=None, unver=True, comm_talk=None, comm_image=None - ) -> None: + def report( + self, + newtext, + image_to_report, + notification=None, + head=None, + notification2=None, + unver: bool = True, + comm_talk=None, + comm_image=None + ) -> None: """Function to make the reports easier.""" self.image_to_report = image_to_report self.newtext = newtext @@ -627,7 +635,7 @@ # we can't find the user, report the problem to the bot return upload_bot_array[0] - def tag_image(self, put=True) -> bool: + def tag_image(self, put: bool = True) -> bool: """Add template to the Image page and find out the uploader.""" # Get the image's description report_page_object = pywikibot.FilePage(self.site, @@ -1040,7 +1048,7 @@ return True # Ok - No problem. Let's continue the checking phase def report_image(self, image_to_report, rep_page=None, com=None, - rep_text=None, addings=True) -> bool: + rep_text=None, addings: bool = True) -> bool: """Report the files to the report page when needed.""" rep_page = rep_page or self.rep_page com = com or self.com diff --git a/scripts/interwiki.py b/scripts/interwiki.py index 98a4250..89e8958 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -710,7 +710,7 @@ return page return None - def translate(self, hints=None, keephintedsites=False) -> None: + def translate(self, hints=None, keephintedsites: bool = False) -> None: """Add the given translation hints to the todo list.""" if self.conf.same and self.origin: if hints: @@ -1296,7 +1296,7 @@ """Return True if all the work for this subject has completed.""" return not self.todo - def problem(self, txt, createneed=True) -> None: + def problem(self, txt, createneed: bool = True) -> None: """Report a problem with the resolution of this subject.""" pywikibot.error(txt) self.confirm = True diff --git a/scripts/patrol.py b/scripts/patrol.py index 921df43..ab04b4e 100755 --- a/scripts/patrol.py +++ b/scripts/patrol.py @@ -370,8 +370,14 @@ return False -def api_feed_repeater(gen, delay: float = 0, repeat=False, namespaces=None, - user=None, recent_new_gen=True): +def api_feed_repeater( + gen, + delay: float = 0, + repeat: bool = False, + namespaces=None, + user=None, + recent_new_gen: bool = True +): """Generator which loads pages details to be processed.""" while True: if recent_new_gen: diff --git a/scripts/redirect.py b/scripts/redirect.py index 7ed9702..8738b0a 100755 --- a/scripts/redirect.py +++ b/scripts/redirect.py @@ -138,8 +138,10 @@ elif action == 'both': cls.__iter__ = lambda slf: slf.get_redirects_via_api(maxlen=2) - def get_redirects_from_dump(self, alsoGetPageTitles=False) -> Tuple[ - Dict[str, str], Set[str]]: + def get_redirects_from_dump( + self, + alsoGetPageTitles: bool = False + ) -> Tuple[Dict[str, str], Set[str]]: """ Extract redirects from dump. diff --git a/scripts/reflinks.py b/scripts/reflinks.py index 23458ce..ed54129 100755 --- a/scripts/reflinks.py +++ b/scripts/reflinks.py @@ -239,7 +239,7 @@ dead_link = '<ref{}>{}</ref>'.format(self.name, tag) return dead_link - def transform(self, ispdf=False) -> None: + def transform(self, ispdf: bool = False) -> None: """Normalize the title.""" # convert html entities if not ispdf: diff --git a/scripts/solve_disambiguation.py b/scripts/solve_disambiguation.py index 83d4bb0..41286ca 100755 --- a/scripts/solve_disambiguation.py +++ b/scripts/solve_disambiguation.py @@ -397,16 +397,13 @@ def __init__( self, page, - primary=False, + primary: bool = False, minimum: int = 0, - main_only=False + main_only: bool = False ) -> None: """Initializer. :type page: pywikibot.Page - :type primary: bool - :type minimum: int - :type main_only: bool """ self.page = page # if run with the -primary argument, enable the ignore manager @@ -451,11 +448,10 @@ """ - def __init__(self, disamb_page, enabled=False) -> None: + def __init__(self, disamb_page, enabled: bool = False) -> None: """Initializer. :type disamb_page: pywikibot.Page - :type enabled: bool :rtype: None """ @@ -578,7 +574,7 @@ """An option allowing multiple aliases which also select it.""" - def __init__(self, option, shortcuts, stop=True) -> None: + def __init__(self, option, shortcuts, stop: bool = True) -> None: """Initializer.""" super().__init__(option, shortcuts[0], stop=stop) self._aliases = frozenset(s.lower() for s in shortcuts[1:]) @@ -1199,7 +1195,7 @@ page, new_targets=None, unlink_counter: int = 0, - dn=False + dn: bool = False ) -> None: """Setup i18n summary message.""" new_targets = new_targets or [] diff --git a/scripts/weblinkchecker.py b/scripts/weblinkchecker.py index 1daa12b..8f68746 100755 --- a/scripts/weblinkchecker.py +++ b/scripts/weblinkchecker.py @@ -228,7 +228,11 @@ return archive -def weblinks_from_text(text, without_bracketed=False, only_bracketed=False): +def weblinks_from_text( + text, + without_bracketed: bool = False, + only_bracketed: bool = False +): """ Yield web links from text. diff --git a/scripts/welcome.py b/scripts/welcome.py index d317622..8390524 100755 --- a/scripts/welcome.py +++ b/scripts/welcome.py @@ -488,7 +488,7 @@ .format(self.site)) self.welcome_text = site_netext - def bad_name_filer(self, name, force=False) -> bool: + def bad_name_filer(self, name, force: bool = False) -> bool: """Check for bad names.""" if not globalvar.filt_bad_name: return False @@ -726,7 +726,7 @@ .format(globalvar.time_recur, strfstr)) pywikibot.sleep(globalvar.time_recur) - def define_sign(self, force=False) -> List[str]: + def define_sign(self, force: bool = False) -> List[str]: """Setup signature.""" if hasattr(self, '_random_signature') and not force: return self._random_signature -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767615 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I71c8474594c273dcb22f5b6e6675d2d910350e5d Gerrit-Change-Number: 767615 Gerrit-PatchSet: 3 Gerrit-Owner: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] create configuration dict directly in data_ingestion.py
by jenkins-bot (Code Review) 02 Mar '22

02 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767528 ) Change subject: [IMPR] create configuration dict directly in data_ingestion.py ...................................................................... [IMPR] create configuration dict directly in data_ingestion.py Change-Id: I8354c058d1e348bf16936345c2800763e3269a59 --- M scripts/data_ingestion.py 1 file changed, 6 insertions(+), 5 deletions(-) Approvals: D3r1ck01: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/data_ingestion.py b/scripts/data_ingestion.py index b276e37..f8b27cb 100755 --- a/scripts/data_ingestion.py +++ b/scripts/data_ingestion.py @@ -260,17 +260,18 @@ :param configuration_page: page with configuration :type configuration_page: :py:obj:`pywikibot.Page` """ - configuration = {} # Set a bunch of defaults - configuration['csvDialect'] = 'excel' - configuration['csvDelimiter'] = ';' - configuration['csvEncoding'] = 'Windows-1252' # FIXME: Encoding hell + configuration = { + 'csvDialect': 'excel', + 'csvDelimiter': ';', + 'csvEncoding': 'Windows-1252', # FIXME: Encoding hell + } templates = configuration_page.templatesWithParams() for (template, params) in templates: if template.title(with_ns=False) == 'Data ingestion': for param in params: - (field, sep, value) = param.partition('=') + field, _, value = param.partition('=') # Remove leading or trailing spaces field = field.strip() -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767528 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I8354c058d1e348bf16936345c2800763e3269a59 Gerrit-Change-Number: 767528 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com> Gerrit-Reviewer: jenkins-bot Gerrit-CC: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [cleanup] Remove unused tests parts
by jenkins-bot (Code Review) 02 Mar '22

02 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767464 ) Change subject: [cleanup] Remove unused tests parts ...................................................................... [cleanup] Remove unused tests parts - remove unused bot_tests.FakeSaveBotTestCase - remove unused tests/i18n/pywikibot.py - remove api_tests.TestBadTokenRecovery because not test is made and no log is written due to this test Change-Id: I316224f415c97928d6485f007ecee54f75c99d64 --- M tests/api_tests.py M tests/bot_tests.py D tests/i18n/pywikibot.py 3 files changed, 0 insertions(+), 100 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/tests/api_tests.py b/tests/api_tests.py index 6d6447d..f9d22c5 100644 --- a/tests/api_tests.py +++ b/tests/api_tests.py @@ -900,25 +900,6 @@ 'You have no API read permissions. Seems you are not logged in.') -class TestBadTokenRecovery(TestCase): - - """Test that the request recovers from bad tokens.""" - - family = 'wikipedia' - code = 'test' - - write = True - - def test_bad_token(self): - """Test the bad token recovery by corrupting the cache.""" - site = self.get_site() - site.tokens._tokens.setdefault(site.user(), {})['edit'] = 'INVALID' - page = pywikibot.Page(site, 'Pywikibot bad token test') - page.text = ('This page is testing whether pywikibot rerequests ' - 'a token when a badtoken error was received.') - page.save(summary='Bad token test') - - class TestUrlEncoding(TestCase): """Test encode_url() function.""" diff --git a/tests/bot_tests.py b/tests/bot_tests.py index c06cee0..12c89de 100644 --- a/tests/bot_tests.py +++ b/tests/bot_tests.py @@ -32,80 +32,6 @@ super().setUpClass() -class FakeSaveBotTestCase(TestCase): - - """ - An abstract test case which patches the bot class to not actually write. - - It redirects the bot's _save_page to it's own ``bot_save`` method. - Currently userPut, put_current and user_edit_entity call it. By - default it'll call the original method but replace the function - called to actually save the page by ``page_save``. It patches the - bot class as soon as this class' attribute bot is defined. It also - sets the bot's 'always' option to True to avoid user interaction. - - The ``bot_save`` method compares the save counter before the call and - asserts that it has increased by one after the call. It also stores - locally in ``save_called`` if ``page_save`` has been called. If - ``bot_save`` or ``page_save`` are implemented they should call - super's method at some point to make sure these assertions work. At - ``tearDown`` it checks that the pages are saved often enough. The - attribute ``default_assert_saves`` defines the number of saves which - must happen and compares it to the difference using the save counter. - It is possible to define ``assert_saves`` after ``setUp`` to - overwrite the default value for certain tests. By default the number - of saves it asserts are 1. Additionally ``save_called`` increases by - 1 on each call of ``page_save`` and should be equal to - ``assert_saves``. - - This means if the bot class actually does other writes, like using - :py:obj:`pywikibot.page.Page.save` manually, it'll still write. - """ - - @property - def bot(self): - """Get the current bot.""" - return self._bot - - @bot.setter - def bot(self, value): - """Set and patch the current bot.""" - assert value._save_page != self.bot_save, 'bot may not be patched.' - self._bot = value - self._bot.opt.always = True - self._original = self._bot._save_page - self._bot._save_page = self.bot_save - self._old_counter = self._bot.counter['write'] - - def setUp(self): - """Set up test by resetting the counters.""" - super().setUp() - self.assert_saves = getattr(self, 'default_assert_saves', 1) - self.save_called = 0 - - def tearDown(self): - """Tear down by asserting the counters.""" - self.assertEqual(self._bot.counter['write'], - self._old_counter + self.assert_saves) - self.assertEqual(self.save_called, self.assert_saves) - super().tearDown() - - def bot_save(self, page, func, *args, **kwargs): - """Handle when bot's userPut was called.""" - self.assertGreaterEqual(self._bot.counter['write'], 0) - old_counter = self._bot.counter['write'] - old_local_cnt = self.save_called - result = self._original(page, self.page_save, *args, **kwargs) - self.assertEqual(self._bot.counter['write'], old_counter + 1) - self.assertEqual(self.save_called, old_local_cnt + 1) - self.assertGreater(self._bot.counter['write'], self._old_counter) - return result - - def page_save(self, *args, **kwargs): - """Handle when bot calls the page's save method.""" - self.save_called += 1 - - class TestBotTreatExit: """Mixin to provide handling for treat and exit.""" diff --git a/tests/i18n/pywikibot.py b/tests/i18n/pywikibot.py deleted file mode 100644 index 8fc88bf..0000000 --- a/tests/i18n/pywikibot.py +++ /dev/null @@ -1,7 +0,0 @@ -"""i18n message bundle called 'pywikibot' to fool the i18n loader.""" -# -# (C) Pywikibot team, 2014-2020 -# -# Distributed under the terms of the MIT license. -# -msg = {} -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767464 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I316224f415c97928d6485f007ecee54f75c99d64 Gerrit-Change-Number: 767464 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: add parameter types of int/float/str based on the default values
by jenkins-bot (Code Review) 02 Mar '22

02 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767441 ) Change subject: add parameter types of int/float/str based on the default values ...................................................................... add parameter types of int/float/str based on the default values Change-Id: I456ea45d94bc5c6c28c7b725a34205c0fe468f68 --- M pywikibot/data/api.py M pywikibot/data/sparql.py M pywikibot/data/wikistats.py M pywikibot/family.py M pywikibot/page/__init__.py M pywikibot/site/_apisite.py M pywikibot/site/_datasite.py M pywikibot/site/_extensions.py M pywikibot/site/_generators.py M pywikibot/site/_namespace.py M pywikibot/site/_obsoletesites.py M pywikibot/throttle.py M pywikibot/tools/__init__.py M pywikibot/tools/_deprecate.py M pywikibot/tools/djvu.py M pywikibot/userinterfaces/terminal_interface_base.py M pywikibot/userinterfaces/win32_unicode.py M pywikibot/version.py M scripts/category.py M scripts/checkimages.py M scripts/claimit.py M scripts/commonscat.py M scripts/delete.py M scripts/illustrate_wikidata.py M scripts/interwiki.py M scripts/listpages.py M scripts/noreferences.py M scripts/patrol.py M scripts/redirect.py M scripts/solve_disambiguation.py M scripts/weblinkchecker.py 31 files changed, 175 insertions(+), 99 deletions(-) Approvals: JJMC89: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py index e24f816..f362a0c 100644 --- a/pywikibot/data/api.py +++ b/pywikibot/data/api.py @@ -1561,7 +1561,7 @@ self.wait() return None - def _relogin(self, message='') -> None: + def _relogin(self, message: str = '') -> None: """Force re-login and inform user.""" pywikibot.error('{}{}Forcing re-login.'.format(message, ' ' if message else '')) diff --git a/pywikibot/data/sparql.py b/pywikibot/data/sparql.py index 7277461..c3a44ca 100644 --- a/pywikibot/data/sparql.py +++ b/pywikibot/data/sparql.py @@ -180,7 +180,7 @@ data = self.query(query, headers=headers) return data['boolean'] - def get_items(self, query, item_name='item', result_type=set): + def get_items(self, query, item_name: str = 'item', result_type=set): """ Retrieve items which satisfy given query. diff --git a/pywikibot/data/wikistats.py b/pywikibot/data/wikistats.py index f6db4b4..c56f207 100644 --- a/pywikibot/data/wikistats.py +++ b/pywikibot/data/wikistats.py @@ -71,7 +71,7 @@ ALL_KEYS = set(FAMILY_MAPPING.keys()) | ALL_TABLES - def __init__(self, url='https://wikistats.wmcloud.org/') -> None: + def __init__(self, url: str = 'https://wikistats.wmcloud.org/') -> None: """Initializer.""" self.url = url self._data = {} diff --git a/pywikibot/family.py b/pywikibot/family.py index b563673..b49f88d 100644 --- a/pywikibot/family.py +++ b/pywikibot/family.py @@ -620,7 +620,7 @@ Family._families[fam] = cls return cls - def linktrail(self, code, fallback='_default'): + def linktrail(self, code, fallback: str = '_default'): """Return regex for trailing chars displayed as part of a link. Returns a string, not a compiled regular expression object. @@ -635,7 +635,7 @@ 'ERROR: linktrail in language {language_code} unknown' .format(language_code=code)) - def category_redirects(self, code, fallback='_default'): + def category_redirects(self, code, fallback: str = '_default'): """Return list of category redirect templates.""" if not hasattr(self, '_catredirtemplates') \ or code not in self._catredirtemplates: @@ -681,7 +681,7 @@ """ return self.archived_page_templates.get(code, ()) - def disambig(self, code, fallback='_default'): + def disambig(self, code, fallback: str = '_default'): """Return list of disambiguation templates.""" if code in self.disambiguationTemplates: return self.disambiguationTemplates[code] diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index 2c87afd..15ea6ff 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -135,7 +135,7 @@ '_pageimage', '_item', '_lintinfo', ) - def __init__(self, source, title='', ns=0) -> None: + def __init__(self, source, title: str = '', ns=0) -> None: """ Instantiate a Page object. @@ -2841,7 +2841,7 @@ This class also represents the Wiki page User:<username> """ - def __init__(self, source, title='') -> None: + def __init__(self, source, title: str = '') -> None: """ Initializer for a User object. @@ -3006,7 +3006,7 @@ """ return self.getprops(force).get('rights', []) - def getUserPage(self, subpage=''): + def getUserPage(self, subpage: str = ''): """ Return a Page object relative to this user's main page. @@ -3025,7 +3025,7 @@ subpage = '/' + subpage return Page(Link(self.title() + subpage, self.site)) - def getUserTalkPage(self, subpage=''): + def getUserTalkPage(self, subpage: str = ''): """ Return a Page object relative to this user's main talk page. @@ -3574,7 +3574,7 @@ _cache_attrs = BasePage._cache_attrs + ('_content', ) - def __init__(self, site, title='', **kwargs) -> None: + def __init__(self, site, title: str = '', **kwargs) -> None: """ Initializer. @@ -4471,7 +4471,7 @@ SNAK_TYPES = ('value', 'somevalue', 'novalue') def __init__(self, site, pid, snak=None, hash=None, is_reference=False, - is_qualifier=False, rank='normal', **kwargs) -> None: + is_qualifier=False, rank: str = 'normal', **kwargs) -> None: """ Initializer. @@ -4738,14 +4738,19 @@ .format(value, value_class)) self.target = value - def changeTarget(self, value=None, snaktype='value', **kwargs) -> None: + def changeTarget( + self, + value=None, + snaktype: str = 'value', + **kwargs + ) -> None: """ Set the target value in the data repository. :param value: The new target value. :type value: object - :param snaktype: The new snak type. - :type snaktype: str ('value', 'somevalue', or 'novalue') + :param snaktype: The new snak type ('value', 'somevalue', or + 'novalue'). """ if value: self.setTarget(value) diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 5385883..8ca21bd 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -1230,7 +1230,7 @@ self.loadpageinfo(page) return page._protection - def page_can_be_edited(self, page, action='edit') -> bool: + def page_can_be_edited(self, page, action: str = 'edit') -> bool: """Determine if the page can be modified. Return True if the bot has the permission of needed restriction level @@ -1485,7 +1485,7 @@ @need_right('deleterevision') def deleterevs(self, targettype: str, ids, *, - hide=None, show=None, reason='', target=None): + hide=None, show=None, reason: str = '', target=None): """Delete or undelete specified page revisions, file versions or logs. :see: https://www.mediawiki.org/wiki/API:Revisiondelete diff --git a/pywikibot/site/_datasite.py b/pywikibot/site/_datasite.py index cd21300..5c2c62f 100644 --- a/pywikibot/site/_datasite.py +++ b/pywikibot/site/_datasite.py @@ -177,7 +177,7 @@ raise APIError(data['errors'], '') return data['entities'] - def preload_entities(self, pagelist, groupsize=50): + def preload_entities(self, pagelist, groupsize: int = 50): """ Yield subclasses of WikibaseEntity's with content prefilled. @@ -187,7 +187,6 @@ :param pagelist: an iterable that yields either WikibaseEntity objects, or Page objects linked to an ItemPage. :param groupsize: how many pages to query at a time - :type groupsize: int """ if not hasattr(self, '_entity_namespaces'): self._cache_entity_namespaces() @@ -329,15 +328,15 @@ entity.latest_revision_id = data['pageinfo']['lastrevid'] @need_right('edit') - def changeClaimTarget(self, claim, snaktype='value', + def changeClaimTarget(self, claim, snaktype: str = 'value', bot=True, summary=None): """ Set the claim target to the value of the provided claim target. :param claim: The source of the claim target value :type claim: pywikibot.Claim - :param snaktype: An optional snaktype. Default: 'value' - :type snaktype: str ('value', 'novalue' or 'somevalue') + :param snaktype: An optional snaktype ('value', 'novalue' or + 'somevalue'). Default: 'value' :param bot: Whether to mark the edit as a bot edit :type bot: bool :param summary: Edit summary diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py index 0e5e229..63b8df3 100644 --- a/pywikibot/site/_extensions.py +++ b/pywikibot/site/_extensions.py @@ -369,9 +369,18 @@ return data['flow']['view-topiclist']['result']['topiclist'] @need_extension('Flow') - def load_topiclist(self, page, content_format: str = 'wikitext', limit=100, - sortby='newest', toconly=False, offset=None, - offset_id=None, reverse=False, include_offset=False): + def load_topiclist( + self, + page, + content_format: str = 'wikitext', + limit: int = 100, + sortby: str = 'newest', + toconly=False, + offset=None, + offset_id=None, + reverse=False, + include_offset=False + ): """ Retrieve the topiclist of a Flow board. @@ -380,9 +389,7 @@ :param content_format: The content format to request the data in. must be either 'wikitext', 'html', or 'fixed-html' :param limit: The number of topics to fetch in each request. - :type limit: int - :param sortby: Algorithm to sort topics by. - :type sortby: str (either 'newest' or 'updated') + :param sortby: Algorithm to sort topics by ('newest' or 'updated'). :param toconly: Whether to only include information for the TOC. :type toconly: bool :param offset: The timestamp to start at (when sortby is 'updated'). diff --git a/pywikibot/site/_generators.py b/pywikibot/site/_generators.py index f3aaa0f..5605f22 100644 --- a/pywikibot/site/_generators.py +++ b/pywikibot/site/_generators.py @@ -94,7 +94,7 @@ priority, page = heapq.heappop(prio_queue) yield page - def preloadpages(self, pagelist, *, groupsize=50, templates=False, + def preloadpages(self, pagelist, *, groupsize: int = 50, templates=False, langlinks=False, pageprops=False): """Return a generator to a list of preloaded pages. @@ -791,10 +791,21 @@ for linkdata in pageitem['extlinks']: yield linkdata['*'] - def allpages(self, start='!', prefix='', namespace=0, filterredir=None, - filterlanglinks=None, minsize=None, maxsize=None, - protect_type=None, protect_level=None, reverse=False, - total=None, content=False): + def allpages( + self, + start: str = '!', + prefix: str = '', + namespace=0, + filterredir=None, + filterlanglinks=None, + minsize=None, + maxsize=None, + protect_type=None, + protect_level=None, + reverse=False, + total=None, + content=False + ): """Iterate pages in a single namespace. :see: https://www.mediawiki.org/wiki/API:Allpages @@ -863,8 +874,15 @@ apgen.request['gapdir'] = 'descending' return apgen - def alllinks(self, start='!', prefix='', namespace=0, unique=False, - fromids=False, total=None): + def alllinks( + self, + start: str = '!', + prefix: str = '', + namespace=0, + unique=False, + fromids=False, + total=None + ): """Iterate all links to pages (which need not exist) in one namespace. Note that, in practice, links that were found on pages that have @@ -901,7 +919,7 @@ p._fromid = link['fromid'] yield p - def allcategories(self, start='!', prefix='', total=None, + def allcategories(self, start: str = '!', prefix: str = '', total=None, reverse=False, content=False): """Iterate categories used (which need not have a Category page). @@ -945,7 +963,13 @@ yield from self._bots.values() - def allusers(self, start='!', prefix='', group=None, total=None): + def allusers( + self, + start: str = '!', + prefix: str = '', + group=None, + total=None + ): """Iterate registered users, ordered by username. Iterated values are dicts containing 'name', 'editcount', @@ -970,9 +994,18 @@ augen.request['augroup'] = group return augen - def allimages(self, start='!', prefix='', minsize=None, maxsize=None, - reverse=False, sha1=None, sha1base36=None, - total=None, content=False): + def allimages( + self, + start: str = '!', + prefix: str = '', + minsize=None, + maxsize=None, + reverse=False, + sha1=None, + sha1base36=None, + total=None, + content=False + ): """Iterate all images, ordered by image title. Yields FilePages, but these pages need not exist on the wiki. @@ -2013,7 +2046,7 @@ """ return self.querypage('Listredirects', total) - def protectedpages(self, namespace=0, type='edit', level=False, + def protectedpages(self, namespace=0, type: str = 'edit', level=False, total=None): """ Return protected pages depending on protection level and type. diff --git a/pywikibot/site/_namespace.py b/pywikibot/site/_namespace.py index 120b06b..9a52e73 100644 --- a/pywikibot/site/_namespace.py +++ b/pywikibot/site/_namespace.py @@ -278,7 +278,7 @@ return default_case @classmethod - def builtin_namespaces(cls, case='first-letter'): + def builtin_namespaces(cls, case: str = 'first-letter'): """Return a dict of the builtin namespaces.""" return {i: cls(i, case=cls.default_case(i, case)) for i in range(-2, 16)} diff --git a/pywikibot/site/_obsoletesites.py b/pywikibot/site/_obsoletesites.py index 40643d4..c5f0a50 100644 --- a/pywikibot/site/_obsoletesites.py +++ b/pywikibot/site/_obsoletesites.py @@ -22,7 +22,7 @@ """Initializer.""" super().__init__(code, fam, user) - def _closed_error(self, notice='') -> None: + def _closed_error(self, notice: str = '') -> None: """An error instead of pointless API call.""" pywikibot.error('Site {} has been closed. {}'.format(self.sitename, notice)) diff --git a/pywikibot/throttle.py b/pywikibot/throttle.py index 8c1b764..a77ec52 100644 --- a/pywikibot/throttle.py +++ b/pywikibot/throttle.py @@ -277,7 +277,7 @@ time.sleep(seconds) - def __call__(self, requestsize=1, write=False) -> None: + def __call__(self, requestsize: int = 1, write=False) -> None: """Block the calling program if the throttle time has not expired. Parameter requestsize is the number of Pages to be read/written; diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 685daa5..a5367f8 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -151,7 +151,12 @@ .. versionadded:: 3.0 """ - def __init__(self, message='', category=Warning, filename='') -> None: + def __init__( + self, + message: str = '', + category=Warning, + filename: str = '' + ) -> None: """Initialize the object. The parameter semantics are similar to those of @@ -159,14 +164,12 @@ :param message: A string containing a regular expression that the start of the warning message must match. (case-insensitive) - :type message: str :param category: A class (a subclass of Warning) of which the warning category must be a subclass in order to match. :type category: type :param filename: A string containing a regular expression that the start of the path to the warning module must match. (case-sensitive) - :type filename: str """ self.message_match = re.compile(message, re.I).match self.category = category @@ -614,8 +617,8 @@ ..versionadded:: 3.0 """ - def __init__(self, group=None, target=None, name='GeneratorThread', - args=(), kwargs=None, qsize=65536) -> None: + def __init__(self, group=None, target=None, name: str = 'GeneratorThread', + args=(), kwargs=None, qsize: int = 65536) -> None: """Initializer. Takes same keyword arguments as threading.Thread. target must be a generator function (or other callable that returns @@ -624,7 +627,6 @@ :param qsize: The size of the lookahead queue. The larger the qsize, the more values will be computed in advance of use (which can eat up memory and processor time). - :type qsize: int """ if kwargs is None: kwargs = {} @@ -705,7 +707,7 @@ yield group -def islice_with_ellipsis(iterable, *args, marker='…'): +def islice_with_ellipsis(iterable, *args, marker: str = '…'): """ Generator which yields the first n elements of the iterable. @@ -722,7 +724,6 @@ - ``itertools.islice(iterable, start, stop[, step])`` :param marker: element to yield if iterable still contains elements after showing the required number. Default value: '…' - :type marker: str """ s = slice(*args) _iterable = iter(iterable) @@ -754,13 +755,11 @@ _logger = 'threadlist' - def __init__(self, limit=128, wait_time=2, *args) -> None: + def __init__(self, limit: int = 128, wait_time: float = 2, *args) -> None: """Initializer. :param limit: the number of simultaneous threads - :type limit: int :param wait_time: how long to wait if active threads exceeds limit - :type wait_time: int or float """ self.limit = limit self.wait_time = wait_time @@ -1109,7 +1108,7 @@ return result -def open_archive(filename, mode='rb', use_extension=True): +def open_archive(filename, mode: str = 'rb', use_extension=True): """ Open a file and uncompress it if needed. @@ -1132,7 +1131,6 @@ :param mode: The mode in which the file should be opened. It may either be 'r', 'rb', 'a', 'ab', 'w' or 'wb'. All modes open the file in binary mode. It defaults to 'rb'. - :type mode: str :raises ValueError: When 7za is not available or the opening mode is unknown or it tries to write a 7z archive. :raises FileNotFoundError: When the filename doesn't exist and it tries @@ -1240,14 +1238,18 @@ return result -def file_mode_checker(filename: str, mode=0o600, quiet=False, create=False): +def file_mode_checker( + filename: str, + mode: int = 0o600, + quiet=False, + create=False +): """Check file mode and update it, if needed. .. versionadded: 3.0 :param filename: filename path :param mode: requested file mode - :type mode: int :param quiet: warn about file mode change if False. :type quiet: bool :param create: create the file if it does not exist already @@ -1270,7 +1272,7 @@ warn(warn_str.format(filename, st_mode - stat.S_IFREG, mode)) -def compute_file_hash(filename: str, sha='sha1', bytes_to_read=None): +def compute_file_hash(filename: str, sha: str = 'sha1', bytes_to_read=None): """Compute file hash. Result is expressed as hexdigest(). @@ -1281,7 +1283,6 @@ :param sha: hashing function among the following in hashlib: md5(), sha1(), sha224(), sha256(), sha384(), and sha512() function name shall be passed as string, e.g. 'sha1'. - :type sha: str :param bytes_to_read: only the first bytes_to_read will be considered; if file size is smaller, the whole file will be considered. :type bytes_to_read: None or int diff --git a/pywikibot/tools/_deprecate.py b/pywikibot/tools/_deprecate.py index 87d2135..bff6759 100644 --- a/pywikibot/tools/_deprecate.py +++ b/pywikibot/tools/_deprecate.py @@ -43,7 +43,7 @@ """ -def add_decorated_full_name(obj, stacklevel=1) -> None: +def add_decorated_full_name(obj, stacklevel: int = 1) -> None: """Extract full object name, including class, and store in __full_name__. This must be done on all decorators that are chained together, otherwise @@ -52,7 +52,6 @@ :param obj: An object being decorated :type obj: object :param stacklevel: level to use - :type stacklevel: int """ if hasattr(obj, '__full_name__'): return diff --git a/pywikibot/tools/djvu.py b/pywikibot/tools/djvu.py index d60b6f7..debb78e 100644 --- a/pywikibot/tools/djvu.py +++ b/pywikibot/tools/djvu.py @@ -12,16 +12,13 @@ import pywikibot -def _call_cmd(args, lib='djvulibre') -> tuple: +def _call_cmd(args, lib: str = 'djvulibre') -> tuple: """ Tiny wrapper around subprocess.Popen(). :param args: same as Popen() :type args: str or typing.Sequence[string] - :param lib: library to be logged in logging messages - :type lib: str - :return: returns a tuple (res, stdoutdata), where res is True if dp.returncode != 0 else False """ diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py index b72fdf8..4111d08 100755 --- a/pywikibot/userinterfaces/terminal_interface_base.py +++ b/pywikibot/userinterfaces/terminal_interface_base.py @@ -81,7 +81,11 @@ self.cache = [] self.lock = RLock() - def init_handlers(self, root_logger, default_stream='stderr') -> None: + def init_handlers( + self, + root_logger, + default_stream: str = 'stderr' + ) -> None: """Initialize the handlers for user output. This method initializes handler(s) for output levels VERBOSE (if diff --git a/pywikibot/userinterfaces/win32_unicode.py b/pywikibot/userinterfaces/win32_unicode.py index 6242832..4c67edf 100755 --- a/pywikibot/userinterfaces/win32_unicode.py +++ b/pywikibot/userinterfaces/win32_unicode.py @@ -67,7 +67,7 @@ """Unicode terminal input class.""" - def __init__(self, hConsole, name, bufsize=1024) -> None: + def __init__(self, hConsole, name, bufsize: int = 1024) -> None: """Initialize the input stream.""" self._hConsole = hConsole self.bufsize = bufsize diff --git a/pywikibot/version.py b/pywikibot/version.py index 5e606dd..a84a536 100644 --- a/pywikibot/version.py +++ b/pywikibot/version.py @@ -325,7 +325,7 @@ return (tag, rev, date, hsh) -def getversion_onlinerepo(path='branches/master'): +def getversion_onlinerepo(path: str = 'branches/master'): """Retrieve current framework git hash from Gerrit.""" from pywikibot.comms import http diff --git a/scripts/category.py b/scripts/category.py index ef138cd..eb69f9b 100755 --- a/scripts/category.py +++ b/scripts/category.py @@ -303,7 +303,11 @@ This prevents loading the category pages over and over again. """ - def __init__(self, rebuild=False, filename='category.dump.bz2') -> None: + def __init__( + self, + rebuild=False, + filename: str = 'category.dump.bz2' + ) -> None: """Initializer.""" if not os.path.isabs(filename): filename = config.datafilepath(filename) @@ -1260,7 +1264,13 @@ the tree to stdout. """ - def __init__(self, cat_title, cat_db, filename=None, max_depth=10) -> None: + def __init__( + self, + cat_title, + cat_db, + filename=None, + max_depth: int = 10 + ) -> None: """Initializer.""" self.cat_title = cat_title or \ pywikibot.input( @@ -1277,7 +1287,7 @@ self.max_depth = max_depth self.site = pywikibot.Site() - def treeview(self, cat, current_depth=0, parent=None) -> str: + def treeview(self, cat, current_depth: int = 0, parent=None) -> str: """Return a tree view of all subcategories of cat. The multi-line string contains a tree view of all subcategories of cat, diff --git a/scripts/checkimages.py b/scripts/checkimages.py index fb911dd..d097449 100755 --- a/scripts/checkimages.py +++ b/scripts/checkimages.py @@ -506,9 +506,15 @@ ignore_save_related_errors = True ignore_server_errors = False - def __init__(self, site, log_full_number=25000, sendemail_active=False, - duplicates_report=False, log_full_error=True, - max_user_notify=None) -> None: + def __init__( + self, + site, + log_full_number: int = 25000, + sendemail_active=False, + duplicates_report=False, + log_full_error=True, + max_user_notify=None + ) -> None: """Initializer, define some instance variables.""" self.site = site self.log_full_error = log_full_error diff --git a/scripts/claimit.py b/scripts/claimit.py index 8ca70de..1e80032 100755 --- a/scripts/claimit.py +++ b/scripts/claimit.py @@ -65,13 +65,12 @@ use_from_page = None - def __init__(self, claims, exists_arg='', **kwargs) -> None: + def __init__(self, claims, exists_arg: str = '', **kwargs) -> None: """Initializer. :param claims: A list of wikidata claims :type claims: list :param exists_arg: String specifying how to handle duplicate claims - :type exists_arg: str """ self.available_options['always'] = True super().__init__(**kwargs) diff --git a/scripts/commonscat.py b/scripts/commonscat.py index c0430bd..45bd4e2 100755 --- a/scripts/commonscat.py +++ b/scripts/commonscat.py @@ -332,8 +332,14 @@ summary=summary) def changeCommonscat( - self, page=None, oldtemplate='', oldcat='', - newtemplate='', newcat='', linktitle='') -> None: + self, + page=None, + oldtemplate: str = '', + oldcat: str = '', + newtemplate: str = '', + newcat: str = '', + linktitle: str = '' + ) -> None: """Change the current commonscat template and target.""" if '3=S' in (oldcat, linktitle): return # TODO: handle additional param on de-wiki @@ -448,7 +454,7 @@ commonscatLinktext, commonscatNote) return None - def checkCommonscatLink(self, name=''): + def checkCommonscatLink(self, name: str = ''): """Return the name of a valid commons category. If the page is a redirect this function tries to follow it. diff --git a/scripts/delete.py b/scripts/delete.py index 9e278e9..c08f5fb 100755 --- a/scripts/delete.py +++ b/scripts/delete.py @@ -81,7 +81,7 @@ Supports the same interface as Page, with some added methods. """ - def __init__(self, source, title='', ns=0) -> None: + def __init__(self, source, title: str = '', ns=0) -> None: """Initializer.""" super().__init__(source, title, ns) _cache_attrs = list(super()._cache_attrs) diff --git a/scripts/illustrate_wikidata.py b/scripts/illustrate_wikidata.py index 1a19d41..818c5a5 100755 --- a/scripts/illustrate_wikidata.py +++ b/scripts/illustrate_wikidata.py @@ -28,11 +28,10 @@ """A bot to add Wikidata image claims.""" - def __init__(self, wdproperty='P18', **kwargs) -> None: + def __init__(self, wdproperty: str = 'P18', **kwargs) -> None: """Initializer. :param wdproperty: The property to add. Should be of type commonsMedia - :type wdproperty: str """ super().__init__(**kwargs) self.wdproperty = wdproperty diff --git a/scripts/interwiki.py b/scripts/interwiki.py index 9e2742e..98a4250 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -1303,7 +1303,7 @@ if createneed: self.problemfound = True - def whereReport(self, page, indent=4) -> None: + def whereReport(self, page, indent: int = 4) -> None: """Report found interlanguage links with conflicts.""" for page2 in sorted(self.found_in[page]): if page2 is None: @@ -2067,11 +2067,11 @@ """Check whether there is still more work to do.""" return not self and self.pageGenerator is None - def plus(self, site, count=1) -> None: + def plus(self, site, count: int = 1) -> None: """Helper routine that the Subject class expects in a counter.""" self.counts[site] += count - def minus(self, site, count=1) -> None: + def minus(self, site, count: int = 1) -> None: """Helper routine that the Subject class expects in a counter.""" self.counts[site] -= count self.counts = +self.counts # remove zero and negative counts diff --git a/scripts/listpages.py b/scripts/listpages.py index 6d2aa0e..df8c1f6 100755 --- a/scripts/listpages.py +++ b/scripts/listpages.py @@ -120,7 +120,7 @@ # Identify which formats need outputlang fmt_need_lang = [k for k, v in fmt_options.items() if 'trs_title' in v] - def __init__(self, page, outputlang=None, default='******') -> None: + def __init__(self, page, outputlang=None, default: str = '******') -> None: """ Initializer. @@ -152,7 +152,7 @@ except Error: self.trs_title = '{}:{}'.format(default, page._link.title) - def output(self, num=None, fmt='1') -> str: + def output(self, num=None, fmt: str = '1') -> str: """Output formatted string.""" fmt = self.fmt_options.get(fmt, fmt) # If selected format requires trs_title, outputlang must be set. diff --git a/scripts/noreferences.py b/scripts/noreferences.py index 036f1d2..f44e1ab 100755 --- a/scripts/noreferences.py +++ b/scripts/noreferences.py @@ -684,7 +684,7 @@ index = len(tmpText) return self.createReferenceSection(oldText, index) - def createReferenceSection(self, oldText, index, ident='==') -> str: + def createReferenceSection(self, oldText, index, ident: str = '==') -> str: """Create a reference section and insert it into the given text. :param oldText: page text that is going to be be amended @@ -694,7 +694,6 @@ :type index: int :param ident: symbols to be inserted before and after reference section title - :type ident: str :return: the amended page text with reference section added """ if self.site.code in noTitleRequired: diff --git a/scripts/patrol.py b/scripts/patrol.py index c087486..921df43 100755 --- a/scripts/patrol.py +++ b/scripts/patrol.py @@ -370,7 +370,7 @@ return False -def api_feed_repeater(gen, delay=0, repeat=False, namespaces=None, +def api_feed_repeater(gen, delay: float = 0, repeat=False, namespaces=None, user=None, recent_new_gen=True): """Generator which loads pages details to be processed.""" while True: diff --git a/scripts/redirect.py b/scripts/redirect.py index c928e08..7ed9702 100755 --- a/scripts/redirect.py +++ b/scripts/redirect.py @@ -229,8 +229,10 @@ if chunk: yield chunk - def get_redirects_via_api(self, maxlen=8) -> Generator[Tuple[ - str, Optional[int], str, Optional[str]], None, None]: + def get_redirects_via_api( + self, + maxlen: int = 8 + ) -> Generator[Tuple[str, Optional[int], str, Optional[str]], None, None]: r""" Return a generator that yields tuples of data about redirect Pages. diff --git a/scripts/solve_disambiguation.py b/scripts/solve_disambiguation.py index 7d2bcd8..83d4bb0 100755 --- a/scripts/solve_disambiguation.py +++ b/scripts/solve_disambiguation.py @@ -394,8 +394,13 @@ """Referring Page generator, with an ignore manager.""" - def __init__(self, page, primary=False, minimum=0, main_only=False - ) -> None: + def __init__( + self, + page, + primary=False, + minimum: int = 0, + main_only=False + ) -> None: """Initializer. :type page: pywikibot.Page @@ -1189,8 +1194,13 @@ self.opt.pos += links return True - def setSummaryMessage(self, page, new_targets=None, unlink_counter=0, - dn=False) -> None: + def setSummaryMessage( + self, + page, + new_targets=None, + unlink_counter: int = 0, + dn=False + ) -> None: """Setup i18n summary message.""" new_targets = new_targets or [] # make list of new targets diff --git a/scripts/weblinkchecker.py b/scripts/weblinkchecker.py index 2a2a2d1..1daa12b 100755 --- a/scripts/weblinkchecker.py +++ b/scripts/weblinkchecker.py @@ -567,7 +567,7 @@ It uses several LinkCheckThreads at once to process pages from generator. """ - def __init__(self, http_ignores=None, day=7, **kwargs) -> None: + def __init__(self, http_ignores=None, day: int = 7, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767441 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I456ea45d94bc5c6c28c7b725a34205c0fe468f68 Gerrit-Change-Number: 767441 Gerrit-PatchSet: 3 Gerrit-Owner: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: add return types for some scalars
by jenkins-bot (Code Review) 02 Mar '22

02 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767278 ) Change subject: add return types for some scalars ...................................................................... add return types for some scalars Change-Id: Idd9f428c1e2a621bead120d4c75ef342166399f9 --- M pywikibot/data/api.py M pywikibot/families/commons_family.py M pywikibot/families/i18n_family.py M pywikibot/families/lingualibre_family.py M pywikibot/families/omegawiki_family.py M pywikibot/families/osm_family.py M pywikibot/families/vikidia_family.py M pywikibot/families/wikidata_family.py M pywikibot/families/wikihow_family.py M pywikibot/families/wikispore_family.py M pywikibot/families/wikitech_family.py M pywikibot/family.py M pywikibot/page/__init__.py M pywikibot/scripts/generate_family_file.py M pywikibot/scripts/generate_user_files.py M pywikibot/site/_apisite.py M pywikibot/site/_siteinfo.py M pywikibot/specialbots/_upload.py M pywikibot/textlib.py M pywikibot/throttle.py M pywikibot/tools/__init__.py M pywikibot/tools/chars.py M pywikibot/tools/djvu.py M pywikibot/userinterfaces/gui.py M pywikibot/userinterfaces/terminal_interface_base.py M pywikibot/userinterfaces/terminal_interface_unix.py M scripts/commons_information.py M scripts/commonscat.py M scripts/imagetransfer.py M scripts/interwiki.py M scripts/patrol.py M scripts/reflinks.py M scripts/replace.py M scripts/replicate_wiki.py M scripts/weblinkchecker.py 35 files changed, 83 insertions(+), 83 deletions(-) Approvals: JJMC89: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py index 51db7e0..e24f816 100644 --- a/pywikibot/data/api.py +++ b/pywikibot/data/api.py @@ -1567,7 +1567,7 @@ ' ' if message else '')) self.site._relogin() - def _userinfo_query(self, result): + def _userinfo_query(self, result) -> bool: """Handle userinfo query.""" if self.action == 'query' and 'userinfo' in result.get('query', ()): # if we get passed userinfo in the query result, we can confirm @@ -1604,7 +1604,7 @@ pywikibot.warning('API warning ({}): {}' .format(mod, single_warning)) - def _logged_in(self, code): + def _logged_in(self, code) -> bool: """Check whether user is logged in. Older wikis returned an error instead of a warning when the request @@ -1631,7 +1631,7 @@ self._relogin(message) return False - def _internal_api_error(self, code, error, result): + def _internal_api_error(self, code, error, result) -> bool: """Check for internal_api_error_ or readonly and retry. :raises pywikibot.exceptions.APIMWError: internal_api_error or readonly @@ -2472,7 +2472,7 @@ return None - def _query_continue(self): + def _query_continue(self) -> bool: if all(key not in self.data[self.continue_name] for key in self.continuekey): pywikibot.log( @@ -2484,7 +2484,7 @@ self._add_continues(query_continue_pair) return False # a new request with query-continue is needed - def _continue(self): + def _continue(self) -> bool: self._add_continues(self.data['continue']) return False # a new request with continue is needed diff --git a/pywikibot/families/commons_family.py b/pywikibot/families/commons_family.py index 7ac1656..8db20ad 100644 --- a/pywikibot/families/commons_family.py +++ b/pywikibot/families/commons_family.py @@ -39,7 +39,7 @@ '_default': (('/doc', ), ['commons']), } - def interface(self, code): + def interface(self, code) -> str: """Return 'DataSite' to enable structured data. .. versionadded 6.5 diff --git a/pywikibot/families/i18n_family.py b/pywikibot/families/i18n_family.py index 92e670d..584669b 100644 --- a/pywikibot/families/i18n_family.py +++ b/pywikibot/families/i18n_family.py @@ -15,6 +15,6 @@ name = 'i18n' domain = 'translatewiki.net' - def protocol(self, code): + def protocol(self, code) -> str: """Return https as the protocol for this family.""" return 'https' diff --git a/pywikibot/families/lingualibre_family.py b/pywikibot/families/lingualibre_family.py index 73523ea..7febae9 100644 --- a/pywikibot/families/lingualibre_family.py +++ b/pywikibot/families/lingualibre_family.py @@ -25,10 +25,10 @@ interwiki_forward = 'wikipedia' - def scriptpath(self, code): + def scriptpath(self, code) -> str: """Return the script path for this family.""" return '' - def interface(self, code): + def interface(self, code) -> str: """Return 'DataSite'.""" return 'DataSite' diff --git a/pywikibot/families/omegawiki_family.py b/pywikibot/families/omegawiki_family.py index fb2926b..c13103b 100644 --- a/pywikibot/families/omegawiki_family.py +++ b/pywikibot/families/omegawiki_family.py @@ -15,6 +15,6 @@ name = 'omegawiki' domain = 'www.omegawiki.org' - def scriptpath(self, code): + def scriptpath(self, code) -> str: """Return the script path for this family.""" return '' diff --git a/pywikibot/families/osm_family.py b/pywikibot/families/osm_family.py index 7d66abe..3ff502d 100644 --- a/pywikibot/families/osm_family.py +++ b/pywikibot/families/osm_family.py @@ -44,6 +44,6 @@ 'en': ('In Bearbeitung',), } - def protocol(self, code): + def protocol(self, code) -> str: """Return https as the protocol for this family.""" return 'https' diff --git a/pywikibot/families/vikidia_family.py b/pywikibot/families/vikidia_family.py index aa765ae..6893c7c 100755 --- a/pywikibot/families/vikidia_family.py +++ b/pywikibot/families/vikidia_family.py @@ -22,6 +22,6 @@ # Sites we want to edit but not count as real languages test_codes = ['central', 'test'] - def protocol(self, code): + def protocol(self, code) -> str: """Return https as the protocol for this family.""" return 'https' diff --git a/pywikibot/families/wikidata_family.py b/pywikibot/families/wikidata_family.py index 06e1391..02ffcf7 100644 --- a/pywikibot/families/wikidata_family.py +++ b/pywikibot/families/wikidata_family.py @@ -41,15 +41,15 @@ 'wikidata': ('wikidata', 'test', 'beta') }) - def interface(self, code): + def interface(self, code) -> str: """Return 'DataSite'.""" return 'DataSite' - def calendarmodel(self, code): + def calendarmodel(self, code) -> str: """Default calendar model for WbTime datatype.""" return 'http://www.wikidata.org/entity/Q1985727' - def default_globe(self, code): + def default_globe(self, code) -> str: """Default globe for Coordinate datatype.""" return 'earth' diff --git a/pywikibot/families/wikihow_family.py b/pywikibot/families/wikihow_family.py index 38d3ab4..7c98124 100644 --- a/pywikibot/families/wikihow_family.py +++ b/pywikibot/families/wikihow_family.py @@ -57,10 +57,10 @@ cls.langs[code] = 'www.' + domain return cls.langs - def scriptpath(self, code): + def scriptpath(self, code) -> str: """Return the script path for this family.""" return '' - def protocol(self, code): + def protocol(self, code) -> str: """Return 'https' as the protocol.""" return 'https' diff --git a/pywikibot/families/wikispore_family.py b/pywikibot/families/wikispore_family.py index 7178ea9..2f4681b 100644 --- a/pywikibot/families/wikispore_family.py +++ b/pywikibot/families/wikispore_family.py @@ -23,5 +23,5 @@ 'test': 'wikispore-test.wmflabs.org', } - def protocol(self, code): + def protocol(self, code) -> str: return 'https' diff --git a/pywikibot/families/wikitech_family.py b/pywikibot/families/wikitech_family.py index 4535f0d..400a237 100644 --- a/pywikibot/families/wikitech_family.py +++ b/pywikibot/families/wikitech_family.py @@ -15,6 +15,6 @@ name = 'wikitech' code = 'en' - def protocol(self, code): + def protocol(self, code) -> str: """Return the protocol for this family.""" return 'https' diff --git a/pywikibot/family.py b/pywikibot/family.py index 1221fa8..b563673 100644 --- a/pywikibot/family.py +++ b/pywikibot/family.py @@ -743,7 +743,7 @@ """ return '/w' - def ssl_pathprefix(self, code): + def ssl_pathprefix(self, code) -> str: """The path prefix for secure HTTP access.""" # Override this ONLY if the wiki family requires a path prefix return '' @@ -773,15 +773,15 @@ uri = self.ssl_pathprefix(code) + uri return urlparse.urljoin('{}://{}'.format(protocol, host), uri) - def path(self, code): + def path(self, code) -> str: """Return path to index.php.""" return '{}/index.php'.format(self.scriptpath(code)) - def querypath(self, code): + def querypath(self, code) -> str: """Return path to query.php.""" return '{}/query.php'.format(self.scriptpath(code)) - def apipath(self, code): + def apipath(self, code) -> str: """Return path to api.php.""" return '{}/api.php'.format(self.scriptpath(code)) @@ -799,7 +799,7 @@ """ raise NotImplementedError('This family does not support EventStreams') - def get_address(self, code, title): + def get_address(self, code, title) -> str: """Return the path to title using index.php with redirects disabled.""" return '{}?title={}&redirect=no'.format(self.path(code), title) @@ -889,11 +889,11 @@ """Return the maximum URL length for GET instead of POST.""" return config.maximum_GET_length - def dbName(self, code): + def dbName(self, code) -> str: """Return the name of the MySQL database.""" return '{}{}'.format(code, self.name) - def encoding(self, code): + def encoding(self, code) -> str: """Return the encoding for a specific language wiki.""" return 'utf-8' @@ -930,7 +930,7 @@ """Return the shared image repository, if any.""" return (None, None) - def isPublic(self, code): + def isPublic(self, code) -> bool: """Check the wiki require logging in before viewing it.""" return True @@ -1084,7 +1084,7 @@ return {code: cls.domain for code in codes} - def protocol(self, code): + def protocol(self, code) -> str: """Return 'https' as the protocol.""" return 'https' @@ -1211,15 +1211,15 @@ """Return Wikimedia Commons as the shared image repository.""" return ('commons', 'commons') - def protocol(self, code): + def protocol(self, code) -> str: """Return 'https' as the protocol.""" return 'https' - def eventstreams_host(self, code): + def eventstreams_host(self, code) -> str: """Return 'https://stream.wikimedia.org' as the stream hostname.""" return 'https://stream.wikimedia.org' - def eventstreams_path(self, code): + def eventstreams_path(self, code) -> str: """Return path for EventStreams.""" return '/v2/stream' @@ -1229,7 +1229,7 @@ """Single site family for sites hosted at ``*.wikimedia.org``.""" @classproperty - def domain(cls): + def domain(cls) -> str: """Return the parents domain with a subdomain prefix.""" return '{}.wikimedia.org'.format(cls.name) diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index 8fcbb94..2c87afd 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -3480,7 +3480,7 @@ del self._content self.latest_revision_id = updates['entity'].get('lastrevid') - def concept_uri(self): + def concept_uri(self) -> str: """ Return the full concept URI. @@ -4531,7 +4531,7 @@ return not self.__eq__(other) @staticmethod - def _claim_mapping_same(this, other): + def _claim_mapping_same(this, other) -> bool: if len(this) != len(other): return False my_values = list(chain.from_iterable(this.values())) @@ -4547,7 +4547,7 @@ return True def same_as(self, other, ignore_rank=True, ignore_quals=False, - ignore_refs=True): + ignore_refs=True) -> bool: """Check if two claims are same.""" if ignore_rank: attributes = ['id', 'snaktype', 'target'] @@ -5181,7 +5181,7 @@ return '{}:{}'.format(name, self.title) return self.title - def astext(self, onsite=None): + def astext(self, onsite=None) -> str: """ Return a text representation of the link. diff --git a/pywikibot/scripts/generate_family_file.py b/pywikibot/scripts/generate_family_file.py index 16753d7..e109e7a 100755 --- a/pywikibot/scripts/generate_family_file.py +++ b/pywikibot/scripts/generate_family_file.py @@ -88,7 +88,7 @@ self.wikis = {} # {'https://wiki/$1': Wiki('https://wiki/$1'), ...} self.langs = [] # [Wiki('https://wiki/$1'), ...] - def get_params(self): # pragma: no cover + def get_params(self) -> bool: # pragma: no cover """Ask for parameters if necessary.""" if self.base_url is None: self.base_url = input('Please insert URL to wiki: ') diff --git a/pywikibot/scripts/generate_user_files.py b/pywikibot/scripts/generate_user_files.py index 064229a..b4c09c9 100755 --- a/pywikibot/scripts/generate_user_files.py +++ b/pywikibot/scripts/generate_user_files.py @@ -91,7 +91,7 @@ return False -def file_exists(filename): +def file_exists(filename) -> bool: """Return whether the file exists and print a message if it exists.""" if os.path.exists(filename): pywikibot.output('{1} already exists in the target directory "{0}".' diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index cd14ab2..5385883 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -279,7 +279,7 @@ return self._request_class({'parameters': kwargs}).create_simple( self, **kwargs) - def logged_in(self): + def logged_in(self) -> bool: """Verify the bot is logged into the site as the expected user. The expected usernames are those provided as the user parameter @@ -763,7 +763,7 @@ """ return self.has_all_mediawiki_messages([key], lang=lang) - def has_all_mediawiki_messages(self, keys, lang=None): + def has_all_mediawiki_messages(self, keys, lang=None) -> bool: """Confirm that the site defines a set of MediaWiki messages. :param keys: names of MediaWiki messages @@ -970,7 +970,7 @@ return _namespaces - def has_extension(self, name): + def has_extension(self, name) -> bool: """Determine whether extension `name` is loaded. :param name: The extension to check for, case sensitive @@ -1230,7 +1230,7 @@ self.loadpageinfo(page) return page._protection - def page_can_be_edited(self, page, action='edit'): + def page_can_be_edited(self, page, action='edit') -> bool: """Determine if the page can be modified. Return True if the bot has the permission of needed restriction level diff --git a/pywikibot/site/_siteinfo.py b/pywikibot/site/_siteinfo.py index 5999e1c..90bb9e9 100644 --- a/pywikibot/site/_siteinfo.py +++ b/pywikibot/site/_siteinfo.py @@ -132,7 +132,7 @@ is the default value. :see: https://www.mediawiki.org/wiki/API:Meta#siteinfo_.2F_si """ - def warn_handler(mod, message): + def warn_handler(mod, message) -> bool: """Return True if the warning is handled.""" matched = Siteinfo.WARNING_REGEX.match(message) if mod == 'siteinfo' and matched: diff --git a/pywikibot/specialbots/_upload.py b/pywikibot/specialbots/_upload.py index bb2cd34..4bfb79f 100644 --- a/pywikibot/specialbots/_upload.py +++ b/pywikibot/specialbots/_upload.py @@ -441,7 +441,7 @@ return None - def skip_run(self): + def skip_run(self) -> bool: """Check whether processing is to be skipped.""" # early check that upload is enabled if self.target_site.is_uploaddisabled(): diff --git a/pywikibot/textlib.py b/pywikibot/textlib.py index 1821fb2..8f4b566 100644 --- a/pywikibot/textlib.py +++ b/pywikibot/textlib.py @@ -1967,7 +1967,7 @@ return (txt, None) @staticmethod - def _valid_date_dict_positions(dateDict): + def _valid_date_dict_positions(dateDict) -> bool: """Check consistency of reasonable positions for groups.""" time_pos = dateDict['time']['start'] tzinfo_pos = dateDict['tzinfo']['start'] diff --git a/pywikibot/throttle.py b/pywikibot/throttle.py index c9627f1..8c1b764 100644 --- a/pywikibot/throttle.py +++ b/pywikibot/throttle.py @@ -90,7 +90,7 @@ @property @deprecated(since='6.2') - def multiplydelay(self): + def multiplydelay(self) -> bool: """DEPRECATED attribute.""" return True diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index c6e476b..685daa5 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -83,7 +83,7 @@ return False -def has_module(module, version=None): +def has_module(module, version=None) -> bool: """Check if a module can be imported. .. versionadded:: 3.0 diff --git a/pywikibot/tools/chars.py b/pywikibot/tools/chars.py index 8cc36dd..6ffe762 100644 --- a/pywikibot/tools/chars.py +++ b/pywikibot/tools/chars.py @@ -28,7 +28,7 @@ def replace_invisible(text): """Replace invisible characters by '<codepoint>'.""" - def replace(match): + def replace(match) -> str: match = match.group() if sys.maxunicode < 0x10ffff and len(match) == 2: mask = (1 << 10) - 1 diff --git a/pywikibot/tools/djvu.py b/pywikibot/tools/djvu.py index cfc1c80..d60b6f7 100644 --- a/pywikibot/tools/djvu.py +++ b/pywikibot/tools/djvu.py @@ -243,7 +243,7 @@ return self._remove_control_chars(stdoutdata) @check_page_number - def whiten_page(self, n): + def whiten_page(self, n) -> bool: """Replace page 'n' of djvu file with a blank page. :param n: page n of djvu file @@ -294,7 +294,7 @@ return True @check_page_number - def delete_page(self, n): + def delete_page(self, n) -> bool: """Delete page 'n' of djvu file. :param n: page n of djvu file diff --git a/pywikibot/userinterfaces/gui.py b/pywikibot/userinterfaces/gui.py index cae3559..c13e761 100644 --- a/pywikibot/userinterfaces/gui.py +++ b/pywikibot/userinterfaces/gui.py @@ -137,24 +137,24 @@ if keylist: self.event_add(event, *keylist) - def cut(self, event): + def cut(self, event) -> str: """Perform cut operation.""" if self.tag_ranges('sel'): self.event_generate('<<Cut>>') return 'break' - def copy(self, event): + def copy(self, event) -> str: """Perform copy operation.""" if self.tag_ranges('sel'): self.event_generate('<<Copy>>') return 'break' - def paste(self, event): + def paste(self, event) -> str: """Perform paste operation.""" self.event_generate('<<Paste>>') return 'break' - def select_all(self, event=None): + def select_all(self, event=None) -> str: """Perform select all operation.""" self.tag_add('sel', '1.0', 'end-1c') self.mark_set('insert', '1.0') @@ -166,17 +166,17 @@ self.tag_remove('sel', '1.0', 'end') self.see('insert') - def del_word_left(self, event): + def del_word_left(self, event) -> str: """Perform delete word (left) operation.""" self.event_generate('<Meta-Delete>') return 'break' - def del_word_right(self, event=None): + def del_word_right(self, event=None) -> str: """Perform delete word (right) operation.""" self.event_generate('<Meta-d>') return 'break' - def find_event(self, event=None): + def find_event(self, event=None) -> str: """Perform find operation.""" if not self.tag_ranges('sel'): found = self.tag_ranges('found') @@ -187,17 +187,17 @@ SearchDialog.find(self) return 'break' - def find_again_event(self, event=None): + def find_again_event(self, event=None) -> str: """Perform find again operation.""" SearchDialog.find_again(self) return 'break' - def find_selection_event(self, event=None): + def find_selection_event(self, event=None) -> str: """Perform find selection operation.""" SearchDialog.find_selection(self) return 'break' - def replace_event(self, event=None): + def replace_event(self, event=None) -> str: """Perform replace operation.""" ReplaceDialog.replace(self) return 'break' @@ -431,7 +431,7 @@ self.text = self.editbox.get('1.0', tkinter.END) self.parent.destroy() - def debug(self, event=None): + def debug(self, event=None) -> str: """Call quit() and return 'break'.""" self.quit() return 'break' diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py index 8909aa7..b72fdf8 100755 --- a/pywikibot/userinterfaces/terminal_interface_base.py +++ b/pywikibot/userinterfaces/terminal_interface_base.py @@ -145,7 +145,7 @@ """Optionally encode and write the text to the target stream.""" target_stream.write(text) - def support_color(self, target_stream): + def support_color(self, target_stream) -> bool: """Return whether the target stream does support colors.""" return False diff --git a/pywikibot/userinterfaces/terminal_interface_unix.py b/pywikibot/userinterfaces/terminal_interface_unix.py index 2a56196..4174ea5 100755 --- a/pywikibot/userinterfaces/terminal_interface_unix.py +++ b/pywikibot/userinterfaces/terminal_interface_unix.py @@ -34,7 +34,7 @@ """User interface for Unix terminals.""" - def support_color(self, target_stream): + def support_color(self, target_stream) -> bool: """Return that the target stream supports colors.""" return True diff --git a/scripts/commons_information.py b/scripts/commons_information.py index baa2637..466ddfe 100755 --- a/scripts/commons_information.py +++ b/scripts/commons_information.py @@ -59,7 +59,7 @@ return langdetect.detect_langs(text) return None - def process_desc_template(self, template): + def process_desc_template(self, template) -> bool: """Process description template.""" tmp_page = pywikibot.Page(self.site, template.name.strip(), ns=10) if tmp_page in self.lang_tmps and len(template.params) == 1 \ diff --git a/scripts/commonscat.py b/scripts/commonscat.py index b58b6ab..c0430bd 100755 --- a/scripts/commonscat.py +++ b/scripts/commonscat.py @@ -250,7 +250,7 @@ return super().skip_page(page) @staticmethod - def skipPage(page): + def skipPage(page) -> bool: """Determine if the page should be skipped.""" try: templates_to_ignore = ignoreTemplates[page.site.code] diff --git a/scripts/imagetransfer.py b/scripts/imagetransfer.py index 3f60988..d43edda 100755 --- a/scripts/imagetransfer.py +++ b/scripts/imagetransfer.py @@ -326,7 +326,7 @@ pywikibot.output( color_format('{yellow}No such image number.{default}')) - def transfer_allowed(self, image): + def transfer_allowed(self, image) -> bool: """Check whether transfer is allowed.""" target_repo = self.opt.target.image_repository() diff --git a/scripts/interwiki.py b/scripts/interwiki.py index 6e9d5a5..9e2742e 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -468,7 +468,7 @@ if not self.quiet: pywikibot.output('NOTE: ' + text) - def readOptions(self, option): + def readOptions(self, option) -> bool: """Read all commandline parameters for the global container.""" arg, _, value = option.partition(':') if not arg.startswith('-'): @@ -779,7 +779,7 @@ self.todo.clear() self.forcedStop = True - def addIfNew(self, page, counter, linkingPage): + def addIfNew(self, page, counter, linkingPage) -> bool: """ Add the pagelink given to the todo list, if it hasn't been seen yet. @@ -819,7 +819,7 @@ or self.namespaceMismatch(page, target, counter) \ or self.wiktionaryMismatch(target) - def namespaceMismatch(self, linkingPage, linkedPage, counter): + def namespaceMismatch(self, linkingPage, linkedPage, counter) -> bool: """ Check whether or not the given page has a different namespace. @@ -897,7 +897,7 @@ # or no origin page yet, also no problem return False - def wiktionaryMismatch(self, page): + def wiktionaryMismatch(self, page) -> bool: """Check for ignoring pages.""" if self.origin and self.conf.same == 'wiktionary': if page.title().lower() != self.origin.title().lower(): @@ -999,7 +999,7 @@ # We can follow the page. return (False, None) - def isIgnored(self, page): + def isIgnored(self, page) -> bool: """Return True if pages is to be ignored.""" if page.site.lang in self.conf.neverlink: pywikibot.output('Skipping link {} to an ignored language' @@ -1547,7 +1547,7 @@ if config.interwiki_backlink: self.reportBacklinks(new, updatedSites) - def replaceLinks(self, page, newPages): + def replaceLinks(self, page, newPages) -> bool: """Return True if saving was successful.""" # In this case only continue on the Page we started with if self.conf.localonly and page != self.origin: @@ -2012,7 +2012,7 @@ # foreign page queries we can find. return self.maxOpenSite() - def oneQuery(self): + def oneQuery(self) -> bool: """ Perform one step in the solution process. @@ -2142,7 +2142,7 @@ return mods, mcomment, adding, removing, modifying -def botMayEdit(page): +def botMayEdit(page) -> bool: """Test for allowed edits.""" tmpl = [] with suppress(KeyError): diff --git a/scripts/patrol.py b/scripts/patrol.py index 3dacb6f..c087486 100755 --- a/scripts/patrol.py +++ b/scripts/patrol.py @@ -167,7 +167,7 @@ raise pywikibot.error(str(e)) - def in_list(self, pagelist, title): + def in_list(self, pagelist, title) -> bool: """Check if title present in pagelist.""" verbose_output('Checking whitelist for: ' + title) @@ -259,7 +259,7 @@ return dict(whitelist) - def is_wikisource_author_page(self, title): + def is_wikisource_author_page(self, title) -> bool: """Patrol a single item.""" if self.site.family.name != 'wikisource': return False @@ -344,7 +344,7 @@ self.page_title = page_title self.linkedpages = None - def match(self, page_title): + def match(self, page_title) -> bool: """Match page_title to linkedpages elements.""" if page_title == self.page_title: return True diff --git a/scripts/reflinks.py b/scripts/reflinks.py index d42ce0d..23458ce 100755 --- a/scripts/reflinks.py +++ b/scripts/reflinks.py @@ -219,12 +219,12 @@ self.url = re.sub('#.*', '', self.link) self.title = None - def refTitle(self): + def refTitle(self) -> str: """Return the <ref> with its new title.""" return '<ref{r.name}>[{r.link} {r.title}]</ref>' \ .format(r=self) - def refLink(self): + def refLink(self) -> str: """No title has been found, return the unbracketed link.""" return '<ref{r.name}>{r.link}</ref>'.format(r=self) diff --git a/scripts/replace.py b/scripts/replace.py index 00c9419..f19690f 100755 --- a/scripts/replace.py +++ b/scripts/replace.py @@ -458,7 +458,7 @@ 'To resume, use "-xmlstart:{}" on the command line.' .format(entry.title)) - def isTitleExcepted(self, title): + def isTitleExcepted(self, title) -> bool: """ Return True if one of the exceptions applies for the given title. @@ -771,7 +771,7 @@ summary=self.generate_summary(applied), ignore_save_related_errors=True, **kwargs) - def user_confirm(self, question): + def user_confirm(self, question) -> bool: """Always return True due to our own input choice.""" return True diff --git a/scripts/replicate_wiki.py b/scripts/replicate_wiki.py index 8f9a516..9621252 100755 --- a/scripts/replicate_wiki.py +++ b/scripts/replicate_wiki.py @@ -175,7 +175,7 @@ sync_overview_page.text = output sync_overview_page.save(self.put_message(site)) - def put_message(self, site): + def put_message(self, site) -> str: """Return synchronization message.""" return ('{} replicate_wiki.py synchronization from {}' .format(site.user(), str(self.original))) diff --git a/scripts/weblinkchecker.py b/scripts/weblinkchecker.py index f8eb86a..2a2a2d1 100755 --- a/scripts/weblinkchecker.py +++ b/scripts/weblinkchecker.py @@ -441,7 +441,7 @@ else: self.history_dict[url] = [(page.title(), now, error)] - def set_link_alive(self, url): + def set_link_alive(self, url) -> bool: """ Record that the link is now alive. -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767278 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Idd9f428c1e2a621bead120d4c75ef342166399f9 Gerrit-Change-Number: 767278 Gerrit-PatchSet: 1 Gerrit-Owner: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: add return type annotations to some magaic methods
by jenkins-bot (Code Review) 01 Mar '22

01 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767276 ) Change subject: add return type annotations to some magaic methods ...................................................................... add return type annotations to some magaic methods Change-Id: Ia723f34b1ae3bf3e2580a53b6885bf5ff303e587 --- M pywikibot/__init__.py M pywikibot/comms/eventstreams.py M pywikibot/data/api.py M pywikibot/data/sparql.py M pywikibot/family.py M pywikibot/page/__init__.py M pywikibot/page/_collections.py M pywikibot/page/_revision.py M pywikibot/site/_basesite.py M pywikibot/site/_namespace.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 scripts/interwiki.py M scripts/replace.py M scripts/speedy_delete.py M scripts/unusedfiles.py 19 files changed, 80 insertions(+), 68 deletions(-) Approvals: JJMC89: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/__init__.py b/pywikibot/__init__.py index c6d21a4..29d266e 100644 --- a/pywikibot/__init__.py +++ b/pywikibot/__init__.py @@ -801,7 +801,7 @@ _items = ('text', 'language') - def __init__(self, text: str, language: str): + def __init__(self, text: str, language: str) -> None: """ Create a new WbMonolingualText object. diff --git a/pywikibot/comms/eventstreams.py b/pywikibot/comms/eventstreams.py index 6db0a5c..78c0fef 100644 --- a/pywikibot/comms/eventstreams.py +++ b/pywikibot/comms/eventstreams.py @@ -74,7 +74,7 @@ >>> del stream """ - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer. :keyword site: a project site object. Used when no url is given @@ -124,7 +124,7 @@ kwargs.setdefault('timeout', config.socket_timeout) self.sse_kwargs = kwargs - def __repr__(self): + def __repr__(self) -> str: """Return representation string.""" kwargs = self.sse_kwargs.copy() if self._site != Site(): diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py index ab2441d..51db7e0 100644 --- a/pywikibot/data/api.py +++ b/pywikibot/data/api.py @@ -835,7 +835,7 @@ """Remove the item by setting it to None.""" self[name] = None - def __contains__(self, name): + def __contains__(self, name) -> bool: """Return True if option has been set.""" return name in self._enabled or name in self._disabled @@ -850,7 +850,7 @@ for disabled in self._disabled: yield '!{}'.format(disabled) - def __len__(self): + def __len__(self) -> int: """Return the number of enabled and disabled options.""" return len(self._enabled) + len(self._disabled) @@ -921,7 +921,7 @@ max_retries: Optional[int] = None, retry_wait: Optional[int] = None, use_get: Optional[bool] = None, - parameters=_PARAM_DEFAULT, **kwargs): + parameters=_PARAM_DEFAULT, **kwargs) -> None: """ Create a new Request instance with the given parameters. @@ -1186,7 +1186,7 @@ """Implement dict interface.""" return list(self._params.keys()) - def __contains__(self, key): + def __contains__(self, key) -> bool: """Implement dict interface.""" return key in self._params @@ -1194,7 +1194,7 @@ """Implement dict interface.""" return iter(self._params) - def __len__(self): + def __len__(self) -> int: """Implement dict interface.""" return len(self._params) @@ -1318,13 +1318,13 @@ """ return encode_url(self._encoded_items()) - def __str__(self): + def __str__(self) -> str: """Return a string representation.""" return unquote(self.site.scriptpath() + '/api.php?' + self._http_param_string()) - def __repr__(self): + def __repr__(self) -> str: """Return internal representation.""" return '{}.{}<{}->{!r}>'.format(self.__class__.__module__, self.__class__.__name__, @@ -2203,7 +2203,7 @@ # set_namespace call. Only to be used by _check_result_namespace. _namespaces = None - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """ Initialize a QueryGenerator object. diff --git a/pywikibot/data/sparql.py b/pywikibot/data/sparql.py index b1c7c15..7277461 100644 --- a/pywikibot/data/sparql.py +++ b/pywikibot/data/sparql.py @@ -31,7 +31,7 @@ endpoint: Optional[str] = None, entity_url: Optional[str] = None, repo=None, max_retries: Optional[int] = None, - retry_wait: Optional[float] = None): + retry_wait: Optional[float] = None) -> None: """ Create endpoint. @@ -208,7 +208,7 @@ """Create a SparqlNode.""" self.value = value - def __str__(self): + def __str__(self) -> str: return self.value @@ -231,7 +231,7 @@ return self.value[urllen:] return None - def __repr__(self): + def __repr__(self) -> str: return '<' + self.value + '>' @@ -244,7 +244,7 @@ self.type = data.get('datatype') self.language = data.get('xml:lang') - def __repr__(self): + def __repr__(self) -> str: if self.type: return self.value + '^^' + self.type if self.language: @@ -259,7 +259,7 @@ """Create Bnode.""" super().__init__(data.get('value')) - def __repr__(self): + def __repr__(self) -> str: return '_:' + self.value diff --git a/pywikibot/family.py b/pywikibot/family.py index 879be6d..1221fa8 100644 --- a/pywikibot/family.py +++ b/pywikibot/family.py @@ -920,10 +920,10 @@ def __hash__(self): return hash(self.name) - def __str__(self): + def __str__(self) -> str: return self.name - def __repr__(self): + def __repr__(self) -> str: return 'Family("{}")'.format(self.name) def shared_image_repository(self, code): diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index 4c9eb7d..8fcbb94 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -135,7 +135,7 @@ '_pageimage', '_item', '_lintinfo', ) - def __init__(self, source, title='', ns=0): + def __init__(self, source, title='', ns=0) -> None: """ Instantiate a Page object. @@ -2080,7 +2080,7 @@ """Page: A MediaWiki page.""" - def __init__(self, source, title: str = '', ns=0): + def __init__(self, source, title: str = '', ns=0) -> None: """Instantiate a Page object.""" if isinstance(source, pywikibot.site.BaseSite): if not title: @@ -2280,7 +2280,7 @@ Supports the same interface as Page, with some added methods. """ - def __init__(self, source, title: str = ''): + def __init__(self, source, title: str = '') -> None: """Initializer.""" self._file_revisions = {} # dictionary to cache File history. super().__init__(source, title, 6) @@ -2545,7 +2545,7 @@ """A page in the Category: namespace.""" - def __init__(self, source, title: str = '', sort_key=None): + def __init__(self, source, title: str = '', sort_key=None) -> None: """ Initializer. @@ -2841,7 +2841,7 @@ This class also represents the Wiki page User:<username> """ - def __init__(self, source, title=''): + def __init__(self, source, title='') -> None: """ Initializer for a User object. @@ -3262,7 +3262,7 @@ DATA_ATTRIBUTES = {} # type: Dict[str, Any] - def __init__(self, repo, id_=None): + def __init__(self, repo, id_=None) -> None: """ Initializer. @@ -3278,7 +3278,7 @@ "'{}' is not a valid {} page title" .format(self.id, self.entity_type)) - def __repr__(self): + def __repr__(self) -> str: if self.id != '-1': return 'pywikibot.page.{}({!r}, {!r})'.format( self.__class__.__name__, self.repo, self.id) @@ -3574,7 +3574,7 @@ _cache_attrs = BasePage._cache_attrs + ('_content', ) - def __init__(self, site, title='', **kwargs): + def __init__(self, site, title='', **kwargs) -> None: """ Initializer. @@ -3900,7 +3900,7 @@ 'sitelinks': SiteLinkCollection, } - def __init__(self, site, title=None, ns=None): + def __init__(self, site, title=None, ns=None) -> None: """ Initializer. @@ -4365,7 +4365,7 @@ 'claims': ClaimCollection, } - def __init__(self, source, title=None, datatype=None): + def __init__(self, source, title=None, datatype=None) -> None: """ Initializer. @@ -4471,7 +4471,7 @@ SNAK_TYPES = ('value', 'somevalue', 'novalue') def __init__(self, site, pid, snak=None, hash=None, is_reference=False, - is_qualifier=False, rank='normal', **kwargs): + is_qualifier=False, rank='normal', **kwargs) -> None: """ Initializer. @@ -4516,7 +4516,7 @@ for source in values: source.on_item = item - def __repr__(self): + def __repr__(self) -> str: """Return the representation string.""" return '{cls_name}.fromJSON({}, {})'.format( repr(self.repo), self.toJSON(), cls_name=type(self).__name__) @@ -5033,7 +5033,7 @@ """Give access to class values by key.""" return getattr(self, key) - def __repr__(self): + def __repr__(self) -> str: """Return a more complete string representation.""" return repr(self.__dict__) @@ -5087,7 +5087,7 @@ else: self._sitekey = site - def __repr__(self): + def __repr__(self) -> str: """Return a more complete string representation.""" assert isinstance(self._items, tuple) assert all(isinstance(item, (bytes, str)) for item in self._items) @@ -5270,7 +5270,7 @@ '|&#x[0-9A-Fa-f]+;' ) - def __init__(self, text, source=None, default_namespace=0): + def __init__(self, text, source=None, default_namespace=0) -> None: """ Initializer. diff --git a/pywikibot/page/_collections.py b/pywikibot/page/_collections.py index f4fe56b..5e0b984 100644 --- a/pywikibot/page/_collections.py +++ b/pywikibot/page/_collections.py @@ -55,14 +55,14 @@ def __iter__(self): return iter(self._data) - def __len__(self): + def __len__(self) -> int: return len(self._data) - def __contains__(self, key): + def __contains__(self, key) -> bool: key = self.normalizeKey(key) return key in self._data - def __repr__(self): + def __repr__(self) -> str: return '{}({})'.format(type(self), self._data) @staticmethod @@ -222,13 +222,13 @@ def __iter__(self): return iter(self._data) - def __len__(self): + def __len__(self) -> int: return len(self._data) - def __contains__(self, key): + def __contains__(self, key) -> bool: return key in self._data - def __repr__(self): + def __repr__(self) -> str: return '{}({})'.format(type(self), self._data) @classmethod @@ -384,10 +384,10 @@ def __iter__(self): return iter(self._data) - def __len__(self): + def __len__(self) -> int: return len(self._data) - def __contains__(self, key): + def __contains__(self, key) -> bool: key = self.getdbName(key) return key in self._data diff --git a/pywikibot/page/_revision.py b/pywikibot/page/_revision.py index 6594baf..2aef3c5 100644 --- a/pywikibot/page/_revision.py +++ b/pywikibot/page/_revision.py @@ -79,11 +79,11 @@ """Provide Revision data as iterator.""" return iter(self._data) - def __repr__(self): + def __repr__(self) -> str: """String representation of Revision.""" return '{}({})'.format(self.__class__.__name__, self._data) - def __str__(self): + def __str__(self) -> str: """Printable representation of Revision data.""" return str(self._data) diff --git a/pywikibot/site/_basesite.py b/pywikibot/site/_basesite.py index ad5a8d7..c2a02f9 100644 --- a/pywikibot/site/_basesite.py +++ b/pywikibot/site/_basesite.py @@ -203,7 +203,7 @@ raise AttributeError("{} instance has no attribute '{}'" .format(self.__class__.__name__, attr)) - def __str__(self): + def __str__(self) -> str: """Return string representing this Site's name and code.""" return self.family.name + ':' + self.code @@ -212,7 +212,7 @@ """String representing this Site's name and code.""" return SelfCallString(self.__str__()) - def __repr__(self): + def __repr__(self) -> str: """Return internal representation.""" return '{}("{}", "{}")'.format( self.__class__.__name__, self.code, self.family) diff --git a/pywikibot/site/_namespace.py b/pywikibot/site/_namespace.py index 027a836..120b06b 100644 --- a/pywikibot/site/_namespace.py +++ b/pywikibot/site/_namespace.py @@ -159,7 +159,7 @@ """ return True - def __len__(self): + def __len__(self) -> int: """Obtain length of the iterable.""" return len(self._distinct()) @@ -187,7 +187,7 @@ return name + ':' - def __str__(self): + def __str__(self) -> str: """Return the canonical string representation.""" return self.canonical_prefix() @@ -199,11 +199,11 @@ """Return the custom name with required colons.""" return Namespace._colons(self.id, self.custom_name) - def __int__(self): + def __int__(self) -> int: """Return the namespace id.""" return self.id - def __index__(self): + def __index__(self) -> int: """Return the namespace id.""" return self.id @@ -244,7 +244,7 @@ """Return the ID as a comparison key.""" return self.id - def __repr__(self): + def __repr__(self) -> str: """Return a reconstructable representation.""" standard_attr = ['id', 'custom_name', 'canonical_name', 'aliases'] extra = [(key, self.__dict__[key]) @@ -372,7 +372,7 @@ return self.__getattribute__(attr) - def __len__(self): + def __len__(self) -> int: """Get the number of namespaces.""" return len(self._namespaces) diff --git a/pywikibot/site/_tokenwallet.py b/pywikibot/site/_tokenwallet.py index 564ec77..fd49f32 100644 --- a/pywikibot/site/_tokenwallet.py +++ b/pywikibot/site/_tokenwallet.py @@ -87,14 +87,14 @@ "Action '{}' is not allowed for user {} on {} wiki." .format(key, self.site.user(), self.site)) - def __contains__(self, key): + def __contains__(self, key) -> bool: """Return True if the given token name is cached.""" return key in self._tokens.setdefault(self.site.user(), {}) - def __str__(self): + def __str__(self) -> str: """Return a str representation of the internal tokens dictionary.""" return self._tokens.__str__() - def __repr__(self): + def __repr__(self) -> str: """Return a representation of the internal tokens dictionary.""" return self._tokens.__repr__() diff --git a/pywikibot/site_detect.py b/pywikibot/site_detect.py index 63e2fad..5476890 100644 --- a/pywikibot/site_detect.py +++ b/pywikibot/site_detect.py @@ -30,7 +30,7 @@ """Minimal wiki site class.""" - def __init__(self, fromurl, **kwargs): + def __init__(self, fromurl, **kwargs) -> None: """ Initializer. @@ -90,7 +90,7 @@ raise RuntimeError('Unable to determine articlepath: ' '{}'.format(self.fromurl)) - def __repr__(self): + def __repr__(self) -> str: return '{}("{}")'.format( self.__class__.__name__, self.fromurl) diff --git a/pywikibot/specialbots/_upload.py b/pywikibot/specialbots/_upload.py index bf6350a..bb2cd34 100644 --- a/pywikibot/specialbots/_upload.py +++ b/pywikibot/specialbots/_upload.py @@ -44,7 +44,7 @@ summary: Optional[str] = None, filename_prefix: Optional[str] = None, force_if_shared: bool = False, - **kwargs): + **kwargs) -> None: """Initializer. .. versionchanged:: 6.2 diff --git a/pywikibot/textlib.py b/pywikibot/textlib.py index cea6c70..1821fb2 100644 --- a/pywikibot/textlib.py +++ b/pywikibot/textlib.py @@ -1842,7 +1842,7 @@ """Return no daylight savings time.""" return datetime.timedelta(0) - def __repr__(self): + def __repr__(self) -> str: """Return the internal representation of the timezone.""" return '{}({}, {})'.format( self.__class__.__name__, diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 6e52f2c..c6e476b 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -22,7 +22,8 @@ from functools import total_ordering, wraps from importlib import import_module from itertools import chain, zip_longest -from typing import Any, Optional +from types import TracebackType +from typing import Any, Optional, Type from warnings import catch_warnings, showwarning, warn import pkg_resources @@ -176,7 +177,12 @@ """Catch all warnings and store them in `self.log`.""" self.log = super().__enter__() - def __exit__(self, exc_type, exc_val, exc_tb) -> None: + def __exit__( + self, + exc_type: Optional[Type[BaseException]], + exc_val: Optional[BaseException], + exc_tb: Optional[TracebackType] + ) -> None: """Stop logging warnings and show those that do not match to params.""" super().__exit__(exc_type, exc_val, exc_tb) for warning in self.log: @@ -562,7 +568,7 @@ """Delegate attributes and methods to self._lock.""" return getattr(self._lock, name) - def __repr__(self): + def __repr__(self) -> str: """Representation of tools.RLock instance.""" return repr(self._lock).replace( '_thread.RLock', @@ -609,7 +615,7 @@ """ def __init__(self, group=None, target=None, name='GeneratorThread', - args=(), kwargs=None, qsize=65536): + args=(), kwargs=None, qsize=65536) -> None: """Initializer. Takes same keyword arguments as threading.Thread. target must be a generator function (or other callable that returns @@ -748,7 +754,7 @@ _logger = 'threadlist' - def __init__(self, limit=128, wait_time=2, *args): + def __init__(self, limit=128, wait_time=2, *args) -> None: """Initializer. :param limit: the number of simultaneous threads @@ -1095,7 +1101,7 @@ return self.popleft() raise StopIteration - def __repr__(self): + def __repr__(self) -> str: """Provide an object representation without clearing the content.""" items = list(self) result = '{}({})'.format(self.__class__.__name__, items) diff --git a/scripts/interwiki.py b/scripts/interwiki.py index fff4d5c..6e9d5a5 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -2081,7 +2081,7 @@ while not self.isDone(): self.queryStep() - def __len__(self): + def __len__(self) -> int: """Return length of subjects.""" return len(self.subjects) diff --git a/scripts/replace.py b/scripts/replace.py index 035ba41..00c9419 100755 --- a/scripts/replace.py +++ b/scripts/replace.py @@ -536,7 +536,13 @@ about the missing site """ - def __init__(self, generator, replacements, exceptions=None, **kwargs): + def __init__( + self, + generator, + replacements, + exceptions=None, + **kwargs + ) -> None: """Initializer.""" self.available_options.update({ 'addcat': None, diff --git a/scripts/speedy_delete.py b/scripts/speedy_delete.py index dcbcde1..5aff328 100755 --- a/scripts/speedy_delete.py +++ b/scripts/speedy_delete.py @@ -314,7 +314,7 @@ }, } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer. :keyword site: the site to work on diff --git a/scripts/unusedfiles.py b/scripts/unusedfiles.py index c891f05..c61bee5 100755 --- a/scripts/unusedfiles.py +++ b/scripts/unusedfiles.py @@ -80,7 +80,7 @@ 'usertemplate': '', } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767276 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Ia723f34b1ae3bf3e2580a53b6885bf5ff303e587 Gerrit-Change-Number: 767276 Gerrit-PatchSet: 1 Gerrit-Owner: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: add None return type annotations
by jenkins-bot (Code Review) 01 Mar '22

01 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767270 ) Change subject: add None return type annotations ...................................................................... add None return type annotations Change-Id: Ia3ee041a63ad42ac58cb19b22be4cddc1b050be9 --- M pywikibot/bot.py M pywikibot/comms/eventstreams.py M pywikibot/comms/http.py M pywikibot/data/api.py M pywikibot/data/mysql.py M pywikibot/data/sparql.py M pywikibot/family.py M pywikibot/page/__init__.py M pywikibot/page/_collections.py M pywikibot/page/_decorators.py M pywikibot/page/_revision.py M pywikibot/scripts/generate_family_file.py M pywikibot/scripts/generate_user_files.py M pywikibot/site/_apisite.py M pywikibot/site/_basesite.py M pywikibot/site/_datasite.py M pywikibot/site/_extensions.py M pywikibot/site/_interwikimap.py M pywikibot/site/_namespace.py M pywikibot/site/_obsoletesites.py M pywikibot/site/_siteinfo.py M pywikibot/site/_tokenwallet.py M pywikibot/site_detect.py M pywikibot/specialbots/_unlink.py M pywikibot/textlib.py M pywikibot/throttle.py M pywikibot/tools/__init__.py M pywikibot/tools/_deprecate.py M pywikibot/tools/djvu.py M pywikibot/tools/formatter.py M pywikibot/userinterfaces/_interface_base.py M pywikibot/userinterfaces/buffer_interface.py M pywikibot/userinterfaces/gui.py M pywikibot/userinterfaces/terminal_interface_base.py M pywikibot/userinterfaces/terminal_interface_unix.py M pywikibot/userinterfaces/terminal_interface_win32.py M pywikibot/userinterfaces/transliteration.py M pywikibot/userinterfaces/win32_unicode.py M pywikibot/xmlreader.py M scripts/add_text.py M scripts/blockpageschecker.py M scripts/category.py M scripts/category_redirect.py M scripts/change_pagelang.py M scripts/commons_information.py M scripts/commonscat.py M scripts/data_ingestion.py M scripts/djvutext.py M scripts/download_dump.py M scripts/fixing_redirects.py M scripts/imagetransfer.py M scripts/interwiki.py M scripts/movepages.py M scripts/nowcommons.py M scripts/pagefromfile.py M scripts/parser_function_count.py M scripts/patrol.py M scripts/protect.py M scripts/redirect.py M scripts/reflinks.py M scripts/replace.py M scripts/replicate_wiki.py M scripts/solve_disambiguation.py M scripts/speedy_delete.py M scripts/unusedfiles.py M scripts/watchlist.py M scripts/weblinkchecker.py M scripts/welcome.py 68 files changed, 394 insertions(+), 364 deletions(-) Approvals: JJMC89: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/bot.py b/pywikibot/bot.py index 16a02bf..96d73f5 100644 --- a/pywikibot/bot.py +++ b/pywikibot/bot.py @@ -1260,7 +1260,7 @@ @_treat_counter.setter @deprecated("self.counter['read']", since='7.0.0') - def _treat_counter(self, value): + def _treat_counter(self, value) -> None: self.counter['read'] = value @property @@ -1270,7 +1270,7 @@ @_save_counter.setter @deprecated("self.counter['write']", since='7.0.0') - def _save_counter(self, value): + def _save_counter(self, value) -> None: self.counter['write'] = value @property @@ -1280,7 +1280,7 @@ @_skip_counter.setter @deprecated("self.counter['skip']", since='7.0.0') - def _skip_counter(self, value): + def _skip_counter(self, value) -> None: self.counter['skip'] = value @property diff --git a/pywikibot/comms/eventstreams.py b/pywikibot/comms/eventstreams.py index 71f6d94..6db0a5c 100644 --- a/pywikibot/comms/eventstreams.py +++ b/pywikibot/comms/eventstreams.py @@ -158,7 +158,7 @@ if self._since else ''))) return self._url - 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 the stream. diff --git a/pywikibot/comms/http.py b/pywikibot/comms/http.py index 8fb7b03..84eb68f 100644 --- a/pywikibot/comms/http.py +++ b/pywikibot/comms/http.py @@ -78,7 +78,7 @@ # Prepare flush on quit -def flush(): # pragma: no cover +def flush() -> None: # pragma: no cover """Close the session object. This is called when the module terminates.""" log('Closing network session.') session.close() diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py index be4b0a1..ab2441d 100644 --- a/pywikibot/data/api.py +++ b/pywikibot/data/api.py @@ -51,7 +51,7 @@ r'Waiting for [\w.: ]+: (?P<lag>\d+(?:\.\d+)?) seconds? lagged') -def _invalidate_superior_cookies(family): +def _invalidate_superior_cookies(family) -> None: """ Clear cookies for site's second level domain. @@ -77,12 +77,12 @@ """Workaround for bug in python 3 email handling of CTE binary.""" - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) self._writeBody = self._write_body - def _write_body(self, msg): + def _write_body(self, msg) -> None: if msg['content-transfer-encoding'] == 'binary': self._fp.write(msg.get_payload(decode=True)) else: @@ -122,7 +122,12 @@ init_modules = frozenset(['main', 'paraminfo']) - def __init__(self, site, preloaded_modules=None, modules_only_mode=None): + def __init__( + self, + site, + preloaded_modules=None, + modules_only_mode=None + ) -> None: """ Initializer. @@ -154,7 +159,7 @@ if self.modules_only_mode: self.paraminfo_keys = frozenset(['modules']) - def _add_submodules(self, name, modules): + def _add_submodules(self, name, modules) -> None: """Add the modules to the internal cache or check if equal.""" # The current implementation here doesn't support submodules inside of # submodules, because that would require to fetch all modules when only @@ -217,7 +222,7 @@ self._fetch({'query'}) assert 'query' in self._modules - def _emulate_pageset(self): + def _emulate_pageset(self) -> None: """Emulate the pageset module, which existed until MW 1.24.""" # pageset isn't a module in the new system, so it is emulated, with # the paraminfo from the query module. @@ -378,7 +383,7 @@ if 'pageset' in modules and 'pageset' not in self._paraminfo: self._emulate_pageset() - def _generate_submodules(self, module): + def _generate_submodules(self, module) -> None: """Check and generate submodules for the given module.""" parameters = self._paraminfo[module].get('parameters', []) submodules = set() @@ -683,7 +688,7 @@ def __init__(self, site=None, module: Optional[str] = None, param: Optional[str] = None, - dict: Optional[dict] = None): + dict: Optional[dict] = None) -> None: """ Initializer. @@ -782,7 +787,7 @@ self._enabled = enabled | (self._enabled - disabled - removed) self._disabled = disabled | (self._disabled - enabled - removed) - def clear(self): + def clear(self) -> None: """Clear all enabled and disabled options.""" self._enabled.clear() self._disabled.clear() @@ -826,7 +831,7 @@ return None raise KeyError('Invalid name "{}"'.format(name)) - def __delitem__(self, name): + def __delitem__(self, name) -> None: """Remove the item by setting it to None.""" self[name] = None @@ -1059,14 +1064,14 @@ return cls(site=req_site, parameters=kwargs) @classmethod - def _warn_both(cls): + def _warn_both(cls) -> None: """Warn that kwargs mode was used but parameters was set too.""" warn('Both kwargs and parameters are set in Request.__init__. It ' 'assumes that "parameters" is actually a parameter of the ' 'Request and is added to kwargs.', DeprecationWarning, 3) @classmethod - def _warn_kwargs(cls): + def _warn_kwargs(cls) -> None: """Warn that kwargs was used instead of parameters.""" warn('Instead of using kwargs from Request.__init__, parameters ' 'for the request to the API should be added via the ' @@ -1146,7 +1151,7 @@ """Implement dict interface.""" return self._params[key] - def __setitem__(self, key: str, value): + def __setitem__(self, key: str, value) -> None: """Set MediaWiki API request parameter. :param value: param value(s) @@ -1173,7 +1178,7 @@ else: self._params[key] = list(value) - def __delitem__(self, key): + def __delitem__(self, key) -> None: """Implement dict interface.""" del self._params[key] @@ -1556,7 +1561,7 @@ self.wait() return None - def _relogin(self, message=''): + def _relogin(self, message='') -> None: """Force re-login and inform user.""" pywikibot.error('{}{}Forcing re-login.'.format(message, ' ' if message else '')) @@ -1577,7 +1582,7 @@ return True return False - def _handle_warnings(self, result): + def _handle_warnings(self, result) -> None: if 'warnings' in result: for mod, warning in result['warnings'].items(): if mod == 'info': @@ -1665,7 +1670,7 @@ self.wait() return True - def _ratelimited(self): + def _ratelimited(self) -> None: """Handle ratelimited warning.""" ratelimits = self.site.userinfo['ratelimits'] delay = None @@ -1904,7 +1909,7 @@ """Cached request.""" - def __init__(self, expiry, *args, **kwargs): + def __init__(self, expiry, *args, **kwargs) -> None: """Initialize a CachedRequest object. :param expiry: either a number of days or a datetime.timedelta object @@ -2017,7 +2022,7 @@ pywikibot.output('Could not load cache: {!r}'.format(e)) return False - def _write_cache(self, data): + def _write_cache(self, data) -> None: """Write data to self._cachefile_path().""" data = (self._uniquedescriptionstr(), data, datetime.datetime.utcnow()) with open(self._cachefile_path(), 'wb') as f: @@ -2063,8 +2068,14 @@ after iterating that many values. """ - def __init__(self, action: str, continue_name: str = 'continue', - limit_name: str = 'limit', data_name: str = 'data', **kwargs): + def __init__( + self, + action: str, + continue_name: str = 'continue', + limit_name: str = 'limit', + data_name: str = 'data', + **kwargs + ) -> None: """ Initialize an APIGenerator object. @@ -2091,7 +2102,7 @@ self.request = self.request_class(**kwargs) self.request[self.limit_name] = self.query_increment - def set_query_increment(self, value: int): + def set_query_increment(self, value: int) -> None: """ Set the maximum number of items to be retrieved per API query. @@ -2106,7 +2117,7 @@ .format(self.__class__.__name__, self.query_increment), _logger) - def set_maximum_items(self, value: Union[int, str, None]): + def set_maximum_items(self, value: Union[int, str, None]) -> None: """ Set the maximum number of items to be retrieved from the wiki. @@ -2292,7 +2303,7 @@ self.continuekey = self.modules self._add_slots() - def _add_slots(self): + def _add_slots(self) -> None: """Add slots to params if the site supports multi-content revisions. On MW 1.32+ the following query parameters require slots to be given @@ -2344,7 +2355,7 @@ if not set(request) & deprecated_params: request['adrslots'] = '*' - def set_query_increment(self, value): + def set_query_increment(self, value) -> None: """Set the maximum number of items to be retrieved per API query. If not called, the default is to ask for "max" items and let the @@ -2361,7 +2372,7 @@ .format(self.__class__.__name__, self.query_limit), _logger) - def set_maximum_items(self, value: Union[int, str, None]): + def set_maximum_items(self, value: Union[int, str, None]) -> None: """Set the maximum number of items to be retrieved from the wiki. If not called, most queries will continue as long as there is @@ -2378,7 +2389,7 @@ if value is not None: self.limit = int(value) - def _update_limit(self): + def _update_limit(self) -> None: """Set query limit for self.module based on api response.""" param = self.site._paraminfo.parameter('query+' + self.limited_module, 'limit') @@ -2477,7 +2488,7 @@ self._add_continues(self.data['continue']) return False # a new request with continue is needed - def _add_continues(self, continue_pair): + def _add_continues(self, continue_pair) -> None: for key, value in continue_pair.items(): # query-continue can return ints (continue too?) if isinstance(value, int): @@ -2651,7 +2662,7 @@ """ - def __init__(self, generator: str, g_content=False, **kwargs): + def __init__(self, generator: str, g_content=False, **kwargs) -> None: """ Initializer. @@ -2664,7 +2675,7 @@ """ # If possible, use self.request after __init__ instead of appendParams - def append_params(params, key, value): + def append_params(params, key, value) -> None: if key in params: params[key] += '|' + value else: @@ -2724,7 +2735,7 @@ """ - def __init__(self, prop: str, **kwargs): + def __init__(self, prop: str, **kwargs) -> None: """ Initializer. @@ -2771,7 +2782,7 @@ del self._previous_dicts[prev_title] @staticmethod - def _update_old_result_dict(old_dict, new_dict): + def _update_old_result_dict(old_dict, new_dict) -> None: """Update old result dict with new_dict.""" for k, v in new_dict.items(): if k not in old_dict: @@ -2800,7 +2811,7 @@ """ - def __init__(self, listaction: str, **kwargs): + def __init__(self, listaction: str, **kwargs) -> None: """ Initializer. @@ -2821,7 +2832,7 @@ Yields LogEntry objects instead of dicts. """ - def __init__(self, logtype=None, **kwargs): + def __init__(self, logtype=None, **kwargs) -> None: """Initializer.""" super().__init__('logevents', **kwargs) @@ -3036,7 +3047,7 @@ .format(pagedict['title'])) -def _update_contentmodel(page, pagedict: dict): +def _update_contentmodel(page, pagedict: dict) -> None: """Update page content model.""" page._contentmodel = pagedict.get('contentmodel') # can be None @@ -3047,7 +3058,7 @@ page._quality_text = pagedict['proofread']['quality_text'] -def _update_protection(page, pagedict: dict): +def _update_protection(page, pagedict: dict) -> None: """Update page protection.""" if 'restrictiontypes' in pagedict: page._applicable_protections = set(pagedict['restrictiontypes']) @@ -3057,13 +3068,13 @@ for item in pagedict['protection']} -def _update_revisions(page, revisions): +def _update_revisions(page, revisions) -> None: """Update page revisions.""" for rev in revisions: page._revisions[rev['revid']] = pywikibot.page.Revision(**rev) -def _update_templates(page, templates): +def _update_templates(page, templates) -> None: """Update page templates.""" templ_pages = [pywikibot.Page(page.site, tl['title']) for tl in templates] if hasattr(page, '_templates'): @@ -3072,7 +3083,7 @@ page._templates = templ_pages -def _update_langlinks(page, langlinks): +def _update_langlinks(page, langlinks) -> None: """Update page langlinks.""" links = [pywikibot.Link.langlinkUnsafe(link['lang'], link['*'], source=page.site) @@ -3084,7 +3095,7 @@ page._langlinks = links -def _update_coordinates(page, coordinates): +def _update_coordinates(page, coordinates) -> None: """Update page coordinates.""" coords = [] for co in coordinates: diff --git a/pywikibot/data/mysql.py b/pywikibot/data/mysql.py index 3952570..376e1ab 100644 --- a/pywikibot/data/mysql.py +++ b/pywikibot/data/mysql.py @@ -33,7 +33,7 @@ .. versionadded:: 7.0 """ - def close(self): # pragma: no cover + def close(self) -> None: # pragma: no cover """Send the quit message and close the socket.""" if self._closed or self._sock is None: super().close() diff --git a/pywikibot/data/sparql.py b/pywikibot/data/sparql.py index f4b1899..b1c7c15 100644 --- a/pywikibot/data/sparql.py +++ b/pywikibot/data/sparql.py @@ -204,7 +204,7 @@ class SparqlNode: """Base class for SPARQL nodes.""" - def __init__(self, value): + def __init__(self, value) -> None: """Create a SparqlNode.""" self.value = value @@ -215,7 +215,7 @@ class URI(SparqlNode): """Representation of URI result type.""" - def __init__(self, data: dict, entity_url, **kwargs): + def __init__(self, data: dict, entity_url, **kwargs) -> None: """Create URI object.""" super().__init__(data.get('value')) self.entity_url = entity_url @@ -238,7 +238,7 @@ class Literal(SparqlNode): """Representation of RDF literal result type.""" - def __init__(self, data: dict, **kwargs): + def __init__(self, data: dict, **kwargs) -> None: """Create Literal object.""" super().__init__(data.get('value')) self.type = data.get('datatype') @@ -255,7 +255,7 @@ class Bnode(SparqlNode): """Representation of blank node.""" - def __init__(self, data: dict, **kwargs): + def __init__(self, data: dict, **kwargs) -> None: """Create Bnode.""" super().__init__(data.get('value')) diff --git a/pywikibot/family.py b/pywikibot/family.py index 8ce8fb0..879be6d 100644 --- a/pywikibot/family.py +++ b/pywikibot/family.py @@ -642,7 +642,7 @@ self._get_cr_templates(code, fallback) return self._catredirtemplates[code] - def _get_cr_templates(self, code, fallback): + def _get_cr_templates(self, code, fallback) -> None: """Build list of category redirect templates.""" if not hasattr(self, '_catredirtemplates'): self._catredirtemplates = {} @@ -967,7 +967,7 @@ return types.MappingProxyType(data) @obsolete.setter - def obsolete(self, data): + def obsolete(self, data) -> None: """Split obsolete dict into constituent parts.""" self.interwiki_removals[:] = [old for (old, new) in data.items() if new is None] diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index f3db6ea..4c9eb7d 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -522,7 +522,7 @@ return self._revid @latest_revision_id.deleter - def latest_revision_id(self): + def latest_revision_id(self) -> None: """ Remove the latest revision id set for this Page. @@ -545,7 +545,7 @@ delattr(self, attr) @latest_revision_id.setter - def latest_revision_id(self, value): + def latest_revision_id(self, value) -> None: """Set the latest revision for this Page.""" del self.latest_revision_id self._revid = value @@ -595,7 +595,7 @@ self._text = None if value is None else str(value) @text.deleter - def text(self): + def text(self) -> None: """Delete the current (edited) wikitext.""" if hasattr(self, '_text'): del self._text @@ -1288,7 +1288,7 @@ asynchronous: bool = False, callback=None, show_diff: bool = False, - **kwargs): + **kwargs) -> None: """ Save the page with the contents of the first argument as the text. @@ -1319,7 +1319,7 @@ """ return self.site.watch(self, unwatch) - def clear_cache(self): + def clear_cache(self) -> None: """Clear the cached attributes of the page.""" self._revisions = {} for attr in self._cache_attrs: @@ -1710,7 +1710,7 @@ return sum(cnt[user.username] if isinstance(user, User) else cnt[user] for user in contributors) - def merge_history(self, dest, timestamp=None, reason=None): + def merge_history(self, dest, timestamp=None, reason=None) -> None: """ Merge revisions from this page into another page. @@ -1753,7 +1753,7 @@ reason: Optional[str] = None, prompt: bool = True, mark: bool = False, - automatic_quit: bool = False): + automatic_quit: bool = False) -> None: """ Delete the page from the wiki. Requires administrator status. @@ -1875,7 +1875,7 @@ .format(timestamp)) self._deletedRevs[timestamp]['marked'] = undelete - def undelete(self, reason: Optional[str] = None): + def undelete(self, reason: Optional[str] = None) -> None: """ Undelete revisions based on the markers set by previous calls. @@ -1913,7 +1913,7 @@ def protect(self, reason: Optional[str] = None, protections: Optional[dict] = None, - **kwargs): + **kwargs) -> None: """ Protect or unprotect a wiki page. Requires administrator status. @@ -2288,7 +2288,7 @@ raise ValueError("'{}' is not in the file namespace!" .format(self.title())) - def _load_file_revisions(self, imageinfo): + def _load_file_revisions(self, imageinfo) -> None: for file_rev in imageinfo: # filemissing in API response indicates most fields are missing # see https://gerrit.wikimedia.org/r/c/mediawiki/core/+/533482/ @@ -3096,7 +3096,7 @@ raise err - def unblock(self, reason: Optional[str] = None): + def unblock(self, reason: Optional[str] = None) -> None: """ Remove the block for the user. @@ -3450,7 +3450,7 @@ data[key] = value return data - def editEntity(self, data=None, **kwargs): + def editEntity(self, data=None, **kwargs) -> None: """ Edit an entity using Wikibase wbeditentity API. @@ -3754,16 +3754,16 @@ return self._revid @latest_revision_id.setter - def latest_revision_id(self, value): + def latest_revision_id(self, value) -> None: self._revid = value @latest_revision_id.deleter - def latest_revision_id(self): + def latest_revision_id(self) -> None: # fixme: this seems too destructive in comparison to the parent self.clear_cache() @allow_asynchronous - def editEntity(self, data=None, **kwargs): + def editEntity(self, data=None, **kwargs) -> None: """ Edit an entity using Wikibase wbeditentity API. @@ -3788,7 +3788,7 @@ # kept for the decorator super().editEntity(data, **kwargs) - def editLabels(self, labels, **kwargs): + def editLabels(self, labels, **kwargs) -> None: """ Edit entity labels. @@ -3800,7 +3800,7 @@ data = {'labels': labels} self.editEntity(data, **kwargs) - def editDescriptions(self, descriptions, **kwargs): + def editDescriptions(self, descriptions, **kwargs) -> None: """ Edit entity descriptions. @@ -3812,7 +3812,7 @@ data = {'descriptions': descriptions} self.editEntity(data, **kwargs) - def editAliases(self, aliases, **kwargs): + def editAliases(self, aliases, **kwargs) -> None: """ Edit entity aliases. @@ -3858,7 +3858,7 @@ self.repo.addClaim(self, claim, bot=bot, **kwargs) claim.on_item = self - def removeClaims(self, claims, **kwargs): + def removeClaims(self, claims, **kwargs) -> None: """ Remove the claims from the entity. @@ -4169,7 +4169,7 @@ return self.sitelinks[site].canonical_title() - def setSitelink(self, sitelink, **kwargs): + def setSitelink(self, sitelink, **kwargs) -> None: """ Set sitelinks. Calls setSitelinks(). @@ -4178,7 +4178,7 @@ """ self.setSitelinks([sitelink], **kwargs) - def removeSitelink(self, site, **kwargs): + def removeSitelink(self, site, **kwargs) -> None: """ Remove a sitelink. @@ -4186,7 +4186,7 @@ """ self.removeSitelinks([site], **kwargs) - def removeSitelinks(self, sites, **kwargs): + def removeSitelinks(self, sites, **kwargs) -> None: """ Remove sitelinks. @@ -4199,7 +4199,7 @@ data.append({'site': site, 'title': ''}) self.setSitelinks(data, **kwargs) - def setSitelinks(self, sitelinks, **kwargs): + def setSitelinks(self, sitelinks, **kwargs) -> None: """ Set sitelinks. @@ -4210,7 +4210,7 @@ data = {'sitelinks': sitelinks} self.editEntity(data, **kwargs) - def mergeInto(self, item, **kwargs): + def mergeInto(self, item, **kwargs) -> None: """ Merge the item into another item. @@ -4306,7 +4306,7 @@ 'musical-notation': 'string', } - def __init__(self, site, id: str, datatype: Optional[str] = None): + def __init__(self, site, id: str, datatype: Optional[str] = None) -> None: """ Initializer. @@ -4506,7 +4506,7 @@ return self._on_item @on_item.setter - def on_item(self, item): + def on_item(self, item) -> None: self._on_item = item for values in self.qualifiers.values(): for qualifier in values: @@ -4738,7 +4738,7 @@ .format(value, value_class)) self.target = value - def changeTarget(self, value=None, snaktype='value', **kwargs): + def changeTarget(self, value=None, snaktype='value', **kwargs) -> None: """ Set the target value in the data repository. @@ -4791,7 +4791,7 @@ """Return the rank of the Claim.""" return self.rank - def setRank(self, rank): + def setRank(self, rank) -> None: """Set the rank of the Claim.""" self.rank = rank @@ -4800,7 +4800,7 @@ self.rank = rank return self.repo.save_claim(self, **kwargs) - def changeSnakType(self, value=None, **kwargs): + def changeSnakType(self, value=None, **kwargs) -> None: """ Save the new snak value. @@ -4814,7 +4814,7 @@ """Return a list of sources, each being a list of Claims.""" return self.sources - def addSource(self, claim, **kwargs): + def addSource(self, claim, **kwargs) -> None: """ Add the claim as a source. @@ -4846,7 +4846,7 @@ source[claim.getID()].append(claim) self.sources.append(source) - def removeSource(self, source, **kwargs): + def removeSource(self, source, **kwargs) -> None: """ Remove the source. Call removeSources(). @@ -4855,7 +4855,7 @@ """ self.removeSources([source], **kwargs) - def removeSources(self, sources, **kwargs): + def removeSources(self, sources, **kwargs) -> None: """ Remove the sources. @@ -4888,7 +4888,7 @@ else: self.qualifiers[qualifier.getID()] = [qualifier] - def removeQualifier(self, qualifier, **kwargs): + def removeQualifier(self, qualifier, **kwargs) -> None: """ Remove the qualifier. Call removeQualifiers(). @@ -4897,7 +4897,7 @@ """ self.removeQualifiers([qualifier], **kwargs) - def removeQualifiers(self, qualifiers, **kwargs): + def removeQualifiers(self, qualifiers, **kwargs) -> None: """ Remove the qualifiers. @@ -5024,7 +5024,7 @@ Note: timestamp will be casted to pywikibot.Timestamp. """ - def __init__(self, file_revision): + def __init__(self, file_revision) -> None: """Initiate the class using the dict from L{APISite.loadimageinfo}.""" self.__dict__.update(file_revision) self.timestamp = pywikibot.Timestamp.fromISOformat(self.timestamp) @@ -5058,7 +5058,7 @@ # Components used for __repr__ _items = ('title', 'namespace', '_sitekey') - def __init__(self, title: str, namespace=None, site=None): + def __init__(self, title: str, namespace=None, site=None) -> None: """ Initializer. @@ -5688,7 +5688,7 @@ # Components used for __repr__ _items = ('_sitekey', '_rawtitle', 'badges') - def __init__(self, title, site=None, badges=None): + def __init__(self, title, site=None, badges=None) -> None: """ Initializer. diff --git a/pywikibot/page/_collections.py b/pywikibot/page/_collections.py index 6668a45..f4fe56b 100644 --- a/pywikibot/page/_collections.py +++ b/pywikibot/page/_collections.py @@ -29,7 +29,7 @@ specialised in subclasses. """ - def __init__(self, data=None): + def __init__(self, data=None) -> None: super().__init__() self._data = {} if data: @@ -44,11 +44,11 @@ key = self.normalizeKey(key) return self._data[key] - def __setitem__(self, key, value): + def __setitem__(self, key, value) -> None: key = self.normalizeKey(key) self._data[key] = value - def __delitem__(self, key): + def __delitem__(self, key) -> None: key = self.normalizeKey(key) del self._data[key] @@ -190,7 +190,7 @@ class ClaimCollection(MutableMapping): """A structure holding claims for a Wikibase entity.""" - def __init__(self, repo): + def __init__(self, repo) -> None: """Initializer.""" super().__init__() self.repo = repo @@ -213,10 +213,10 @@ def __getitem__(self, key): return self._data[key] - def __setitem__(self, key, value): + def __setitem__(self, key, value) -> None: self._data[key] = value - def __delitem__(self, key): + def __delitem__(self, key) -> None: del self._data[key] def __iter__(self): @@ -294,7 +294,7 @@ claims = temp return claims - def set_on_item(self, item): + def set_on_item(self, item) -> None: """Set Claim.on_item attribute for all claims in this collection.""" for claims in self.values(): for claim in claims: @@ -304,7 +304,7 @@ class SiteLinkCollection(MutableMapping): """A structure holding SiteLinks for a Wikibase item.""" - def __init__(self, repo, data=None): + def __init__(self, repo, data=None) -> None: """ Initializer. @@ -358,7 +358,7 @@ self._data[key] = val return val - def __setitem__(self, key, val): + def __setitem__(self, key, val) -> None: """ Set the SiteLink for a given key. @@ -377,7 +377,7 @@ assert val.site.dbName() == key self._data[key] = val - def __delitem__(self, key): + def __delitem__(self, key) -> None: key = self.getdbName(key) del self._data[key] diff --git a/pywikibot/page/_decorators.py b/pywikibot/page/_decorators.py index ddd6dc8..4a056e4 100644 --- a/pywikibot/page/_decorators.py +++ b/pywikibot/page/_decorators.py @@ -46,7 +46,7 @@ if callback: callback(self, err) - def wrapper(self, *args, **kwargs): + def wrapper(self, *args, **kwargs) -> None: if kwargs.get('asynchronous'): pywikibot.async_request(handle, func, self, *args, **kwargs) else: diff --git a/pywikibot/page/_revision.py b/pywikibot/page/_revision.py index fcdc140..6594baf 100644 --- a/pywikibot/page/_revision.py +++ b/pywikibot/page/_revision.py @@ -26,14 +26,14 @@ 'Sample for Revision access' """ - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer.""" self._data = kwargs self._upcast_dict(self._data) super().__init__() @staticmethod - def _upcast_dict(map_): + def _upcast_dict(map_) -> None: """Upcast dictionary values.""" with suppress(KeyError): # enable doctest map_['timestamp'] = Timestamp.fromISOformat(map_['timestamp']) diff --git a/pywikibot/scripts/generate_family_file.py b/pywikibot/scripts/generate_family_file.py index 2af8ae3..16753d7 100755 --- a/pywikibot/scripts/generate_family_file.py +++ b/pywikibot/scripts/generate_family_file.py @@ -55,7 +55,7 @@ url: Optional[str] = None, name: Optional[str] = None, dointerwiki: Optional[str] = None, - verify: Optional[str] = None): + verify: Optional[str] = None) -> None: """ Parameters are optional. If not given the script asks for the values. @@ -128,7 +128,7 @@ return w, verify return None, None - def run(self): + def run(self) -> None: """Main method, generate family file.""" if not self.get_params(): return @@ -147,7 +147,7 @@ self.getapis() self.writefile(verify) - def getlangs(self, w): + def getlangs(self, w) -> None: """Determine site code of a family.""" print('Determining other sites...', end='') try: @@ -193,7 +193,7 @@ 'letters and digits [a-z0-9] or underscore/dash [_-]' \ .format(self.name, wiki['prefix']) - def getapis(self): + def getapis(self) -> None: """Load other site pages.""" print('Loading wikis... ') for lang in self.langs: @@ -208,7 +208,7 @@ else: print('in cache') - def writefile(self, verify): + def writefile(self, verify) -> None: """Write the family file.""" fn = os.path.join(self.base_dir, 'families', '{}_family.py'.format(self.name)) @@ -285,7 +285,7 @@ """ -def main(): +def main() -> None: """Process command line arguments and generate a family file.""" if len(sys.argv) > 1 and sys.argv[1] == '-help': print(__doc__) diff --git a/pywikibot/scripts/generate_user_files.py b/pywikibot/scripts/generate_user_files.py index b918aef..064229a 100755 --- a/pywikibot/scripts/generate_user_files.py +++ b/pywikibot/scripts/generate_user_files.py @@ -406,7 +406,7 @@ return userfile, passfile -def main(*args: str): +def main(*args: str) -> None: """ Process command line arguments and generate user-config. diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 3589ad2..cd14ab2 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -105,7 +105,7 @@ Do not instantiate directly; use :py:obj:`pywikibot.Site` function. """ - def __init__(self, code, fam=None, user=None): + def __init__(self, code, fam=None, user=None) -> None: """Initializer.""" super().__init__(code, fam, user) self._globaluserinfo = {} @@ -123,7 +123,7 @@ del new['_interwikimap'] return new - def __setstate__(self, attrs): + def __setstate__(self, attrs) -> None: """Restore things removed in __getstate__.""" super().__setstate__(attrs) self._interwikimap = _InterwikiMap(self) @@ -399,7 +399,7 @@ self._loginstatus = _LoginStatus.NOT_LOGGED_IN # failure - def _relogin(self): + def _relogin(self) -> None: """Force a login sequence without logging out, using the current user. This is an internal function which is used to re-login when @@ -410,7 +410,7 @@ self._loginstatus = _LoginStatus.NOT_LOGGED_IN self.login() - def logout(self): + def logout(self) -> None: """ Logout of the site and load details for the logged out user. @@ -487,7 +487,7 @@ return self._userinfo @userinfo.deleter - def userinfo(self): + def userinfo(self) -> None: """Delete cached userinfo. ..versionadded:: 5.5 @@ -557,7 +557,7 @@ return self.get_globaluserinfo() @globaluserinfo.deleter - def globaluserinfo(self): + def globaluserinfo(self) -> None: """Delete cached globaluserinfo of current user. ..versionadded:: 7.0 @@ -652,7 +652,7 @@ @staticmethod def assert_valid_iter_params(msg_prefix, start, end, reverse, - is_ts=True): + is_ts=True) -> None: """Validate iterating API parameters. :param msg_prefix: The calling method name @@ -1168,7 +1168,7 @@ raise PageRelatedError( page, 'loadimageinfo: Query on {} returned no imageinfo') - def loadpageinfo(self, page, preload=False): + def loadpageinfo(self, page, preload=False) -> None: """Load page info from api and store in page attributes. :see: https://www.mediawiki.org/wiki/API:Info @@ -1184,7 +1184,7 @@ inprop=inprop) self._update_page(page, query) - def loadpageprops(self, page): + def loadpageprops(self, page) -> None: """Load page props for the given page.""" title = page.title(with_section=False) query = self._generator(api.PropertyGenerator, @@ -1194,7 +1194,7 @@ self._update_page(page, query) def loadimageinfo(self, page, history=False, - url_width=None, url_height=None, url_param=None): + url_width=None, url_height=None, url_param=None) -> None: """Load image info from api and save in page attributes. Parameters correspond to iiprops in: @@ -1452,7 +1452,7 @@ parsed_text = data['parse']['text']['*'] return parsed_text - def getcategoryinfo(self, category): + def getcategoryinfo(self, category) -> None: """Retrieve data on contents of category. :see: https://www.mediawiki.org/wiki/API:Categoryinfo diff --git a/pywikibot/site/_basesite.py b/pywikibot/site/_basesite.py index db86186..ad5a8d7 100644 --- a/pywikibot/site/_basesite.py +++ b/pywikibot/site/_basesite.py @@ -172,7 +172,7 @@ del new['_iw_sites'] return new - def __setstate__(self, attrs): + def __setstate__(self, attrs) -> None: """Restore things removed in __getstate__.""" self.__dict__.update(attrs) self._pagemutex = threading.Condition() @@ -293,7 +293,7 @@ self._pagemutex.wait() self._locked_pages.add(title) - def unlock_page(self, page): + def unlock_page(self, page) -> None: """ Unlock page. Call as soon as a write operation has completed. diff --git a/pywikibot/site/_datasite.py b/pywikibot/site/_datasite.py index 56756cf..cd21300 100644 --- a/pywikibot/site/_datasite.py +++ b/pywikibot/site/_datasite.py @@ -34,7 +34,7 @@ """Wikibase data capable site.""" - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) self._item_namespace = None @@ -45,7 +45,7 @@ 'mediainfo': pywikibot.MediaInfo, } - def _cache_entity_namespaces(self): + def _cache_entity_namespaces(self) -> None: """Find namespaces for each known wikibase entity type.""" self._entity_namespaces = {} for entity_type in self._type_to_class: @@ -298,7 +298,7 @@ return req.submit() @need_right('edit') - def addClaim(self, entity, claim, bot=True, summary=None): + def addClaim(self, entity, claim, bot=True, summary=None) -> None: """ Add a claim. diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py index 98e4b75..0e5e229 100644 --- a/pywikibot/site/_extensions.py +++ b/pywikibot/site/_extensions.py @@ -75,7 +75,7 @@ """APISite mixin for ProofreadPage extension.""" @need_extension('ProofreadPage') - def _cache_proofreadinfo(self, expiry=False): + def _cache_proofreadinfo(self, expiry=False) -> None: """Retrieve proofreadinfo from site and cache response. Applicable only to sites with ProofreadPage extension installed. @@ -144,7 +144,7 @@ """APISite mixin for GeoData extension.""" @need_extension('GeoData') - def loadcoordinfo(self, page): + def loadcoordinfo(self, page) -> None: """Load [[mw:Extension:GeoData]] info.""" title = page.title(with_section=False) query = self._generator(api.PropertyGenerator, @@ -162,7 +162,7 @@ """APISite mixin for PageImages extension.""" @need_extension('PageImages') - def loadpageimage(self, page): + def loadpageimage(self, page) -> None: """ Load [[mw:Extension:PageImages]] info. diff --git a/pywikibot/site/_interwikimap.py b/pywikibot/site/_interwikimap.py index de81928..77bbfb6 100644 --- a/pywikibot/site/_interwikimap.py +++ b/pywikibot/site/_interwikimap.py @@ -12,7 +12,7 @@ """An entry of the _InterwikiMap with a lazy loading site.""" - def __init__(self, local, url, prefix=None): + def __init__(self, local, url, prefix=None) -> None: self._site = None self.local = local self.url = url @@ -33,7 +33,7 @@ """A representation of the interwiki map of a site.""" - def __init__(self, site): + def __init__(self, site) -> None: """ Create an empty uninitialized interwiki map for the given site. @@ -44,7 +44,7 @@ self._site = site self._map = None - def reset(self): + def reset(self) -> None: """Remove all mappings to force building a new mapping.""" self._map = None diff --git a/pywikibot/site/_namespace.py b/pywikibot/site/_namespace.py index dbc51de..027a836 100644 --- a/pywikibot/site/_namespace.py +++ b/pywikibot/site/_namespace.py @@ -88,7 +88,7 @@ canonical_name: Optional[str] = None, custom_name: Optional[str] = None, aliases: Optional[List[str]] = None, - **kwargs): + **kwargs) -> None: """Initializer. :param canonical_name: Canonical name @@ -323,7 +323,7 @@ APISite was callable. """ - def __init__(self, namespaces): + def __init__(self, namespaces) -> None: """Create new dict using the given namespaces.""" super().__init__() self._namespaces = namespaces diff --git a/pywikibot/site/_obsoletesites.py b/pywikibot/site/_obsoletesites.py index 3825207..40643d4 100644 --- a/pywikibot/site/_obsoletesites.py +++ b/pywikibot/site/_obsoletesites.py @@ -18,11 +18,11 @@ class ClosedSite(APISite): """Site closed to read-only mode.""" - def __init__(self, code, fam, user=None): + def __init__(self, code, fam, user=None) -> None: """Initializer.""" super().__init__(code, fam, user) - def _closed_error(self, notice=''): + def _closed_error(self, notice='') -> None: """An error instead of pointless API call.""" pywikibot.error('Site {} has been closed. {}'.format(self.sitename, notice)) @@ -39,7 +39,7 @@ 'create': ('steward', 'infinity')} return page._protection - def recentchanges(self, **kwargs): + def recentchanges(self, **kwargs) -> None: """An error instead of pointless API call.""" self._closed_error('No recent changes can be returned.') @@ -49,6 +49,6 @@ self._uploaddisabled = True return self._uploaddisabled - def newpages(self, **kwargs): + def newpages(self, **kwargs) -> None: """An error instead of pointless API call.""" self._closed_error('No new pages can be returned.') diff --git a/pywikibot/site/_siteinfo.py b/pywikibot/site/_siteinfo.py index af88274..5999e1c 100644 --- a/pywikibot/site/_siteinfo.py +++ b/pywikibot/site/_siteinfo.py @@ -58,7 +58,7 @@ ], } - def __init__(self, site): + def __init__(self, site) -> None: """Initialise it with an empty cache.""" self._site = site self._cache = {} @@ -95,7 +95,7 @@ return EMPTY_DEFAULT @staticmethod - def _post_process(prop, data): + def _post_process(prop, data) -> None: """Do some default handling of data. Directly modifies data.""" # Be careful with version tests inside this here as it might need to # query this method to actually get the version number diff --git a/pywikibot/site/_tokenwallet.py b/pywikibot/site/_tokenwallet.py index 53b4d06..564ec77 100644 --- a/pywikibot/site/_tokenwallet.py +++ b/pywikibot/site/_tokenwallet.py @@ -15,7 +15,7 @@ """Container for tokens.""" - def __init__(self, site): + def __init__(self, site) -> None: """Initializer. :type site: pywikibot.site.APISite @@ -24,7 +24,7 @@ self._tokens = {} self.failed_cache = set() # cache unavailable tokens. - def load_tokens(self, types, all=False): + def load_tokens(self, types, all=False) -> None: """ Preload one or multiple tokens. diff --git a/pywikibot/site_detect.py b/pywikibot/site_detect.py index 60fbe42..63e2fad 100644 --- a/pywikibot/site_detect.py +++ b/pywikibot/site_detect.py @@ -108,7 +108,7 @@ return [wiki for wiki in iw['query']['interwikimap'] if 'language' in wiki] - def _fetch_old_version(self): + def _fetch_old_version(self) -> None: """Extract the version from API help with ?version enabled.""" if self.version is None: try: @@ -128,7 +128,7 @@ else: self.version = MediaWikiVersion(self.version) - def _parse_site(self): + def _parse_site(self) -> None: """Parse siteinfo data.""" response = fetch(self.api + '?action=query&meta=siteinfo&format=json') check_response(response) @@ -190,7 +190,7 @@ """Wiki HTML page parser.""" - def __init__(self, url): + def __init__(self, url) -> None: """Initializer.""" super().__init__(convert_charrefs=True) self.url = urlparse(url) @@ -200,14 +200,14 @@ self.server = None self.scriptpath = None - def set_version(self, value): + def set_version(self, value) -> None: """Set highest version.""" if self.version and value < self.version: return self.version = value - def set_api_url(self, url): + def set_api_url(self, url) -> None: """Set api_url.""" url = url.split('.php', 1)[0] try: @@ -257,7 +257,7 @@ self._parsed_url.scheme, self._parsed_url.netloc) self.scriptpath = self._parsed_url.path - def handle_starttag(self, tag, attrs): + def handle_starttag(self, tag, attrs) -> None: """Handle an opening tag.""" attrs = dict(attrs) if tag == 'meta': diff --git a/pywikibot/specialbots/_unlink.py b/pywikibot/specialbots/_unlink.py index cf61dd0..76fd66f 100644 --- a/pywikibot/specialbots/_unlink.py +++ b/pywikibot/specialbots/_unlink.py @@ -24,7 +24,7 @@ """The text should be edited and replacement should be restarted.""" - def __init__(self): + def __init__(self) -> None: """Initializer.""" super().__init__('edit', 'e') self.stop = True @@ -34,7 +34,7 @@ """An implementation which just allows unlinking.""" - def __init__(self, bot): + def __init__(self, bot) -> None: """Create default settings.""" super().__init__(old_link=bot.pageToUnlink, new_link=False, default='u') @@ -58,7 +58,7 @@ """A basic bot unlinking a given link from the current page.""" - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Redirect all parameters and add namespace as an available option.""" self.available_options.update({ 'namespaces': [], @@ -71,7 +71,7 @@ """Create a new callback instance for replace_links.""" return InteractiveUnlink(self) - def unlink(self, target_page): + def unlink(self, target_page) -> None: """Unlink all links linking to the target page.""" text = self.current_page.text while True: diff --git a/pywikibot/textlib.py b/pywikibot/textlib.py index 3fa934e..cea6c70 100644 --- a/pywikibot/textlib.py +++ b/pywikibot/textlib.py @@ -187,7 +187,7 @@ """Build template matcher.""" - def __init__(self, site): + def __init__(self, site) -> None: """Initializer.""" self.site = site @@ -247,7 +247,7 @@ return re.compile(_tag_pattern(tag_name)) -def _create_default_regexes(): +def _create_default_regexes() -> None: """Fill (and possibly overwrite) _regex_cache with default regexes.""" _regex_cache.update({ # categories @@ -539,22 +539,22 @@ textdata = '' keeptags = [] - def __enter__(self): + def __enter__(self) -> None: pass - def __exit__(self, *exc_info): + def __exit__(self, *exc_info) -> None: self.close() - def handle_data(self, data): + def handle_data(self, data) -> None: """Add data to text.""" self.textdata += data - def handle_starttag(self, tag, attrs): + def handle_starttag(self, tag, attrs) -> None: """Add start tag to text if tag should be kept.""" if tag in self.keeptags: self.textdata += '<{}>'.format(tag) - def handle_endtag(self, tag): + def handle_endtag(self, tag) -> None: """Add end tag to text if tag should be kept.""" if tag in self.keeptags: self.textdata += '</{}>'.format(tag) @@ -1825,7 +1825,7 @@ :param name: a string with name of the timezone """ - def __init__(self, offset: int, name: str): + def __init__(self, offset: int, name: str) -> None: """Initializer.""" self.__offset = datetime.timedelta(minutes=offset) self.__name = name @@ -1855,7 +1855,7 @@ """Find timestamp in page and return it as pywikibot.Timestamp object.""" - def __init__(self, site=None): + def __init__(self, site=None) -> None: """Initializer.""" self.site = pywikibot.Site() if site is None else site diff --git a/pywikibot/throttle.py b/pywikibot/throttle.py index 8144f70..c9627f1 100644 --- a/pywikibot/throttle.py +++ b/pywikibot/throttle.py @@ -57,7 +57,7 @@ def __init__(self, site: Union['pywikibot.site.BaseSite', str], *, mindelay: Optional[int] = None, maxdelay: Optional[int] = None, - writedelay: Union[int, float, None] = None): + writedelay: Union[int, float, None] = None) -> None: """Initializer.""" self.lock = threading.RLock() self.lock_write = threading.RLock() @@ -96,7 +96,7 @@ @multiplydelay.setter @deprecated(since='6.2') - def multiplydelay(self): + def multiplydelay(self) -> None: """DEPRECATED attribute setter.""" @staticmethod @@ -140,7 +140,7 @@ continue yield proc_entry - def _write_file(self, processes): + def _write_file(self, processes) -> None: """Write process entries to file.""" if not isinstance(processes, list): processes = list(processes) @@ -150,7 +150,7 @@ for p in processes: f.write(FORMAT_LINE.format_map(p._asdict())) - def checkMultiplicity(self): + def checkMultiplicity(self) -> None: """Count running processes for site and set process_multiplicity. .. versionchanged:: 7.0 @@ -197,7 +197,7 @@ pywikibot.log('Found {} {} processes running, including this one.' .format(count, mysite)) - def setDelays(self, delay=None, writedelay=None, absolute=False): + def setDelays(self, delay=None, writedelay=None, absolute=False) -> None: """Set the nominal delays in seconds. Defaults to config values.""" with self.lock: delay = delay or self.mindelay @@ -246,7 +246,7 @@ ago = now - (self.last_write if write else self.last_read) return max(0.0, thisdelay - ago) - def drop(self): + def drop(self) -> None: """Remove me from the list of running bot processes.""" # drop all throttles with this process's pid, regardless of site self.checktime = 0 @@ -257,7 +257,7 @@ self._write_file(processes) - def wait(self, seconds): + def wait(self, seconds) -> None: """Wait for seconds seconds. Announce the delay if it exceeds a preset limit. @@ -277,7 +277,7 @@ time.sleep(seconds) - def __call__(self, requestsize=1, write=False): + def __call__(self, requestsize=1, write=False) -> None: """Block the calling program if the throttle time has not expired. Parameter requestsize is the number of Pages to be read/written; @@ -304,7 +304,7 @@ else: self.last_read = time.time() - def lag(self, lagtime: Optional[float] = None): + def lag(self, lagtime: Optional[float] = None) -> None: """Seize the throttle lock due to server lag. Usually the `self.retry-after` value from `response_header` of the diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 9e19104..6e52f2c 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -130,7 +130,7 @@ .. versionadded:: 3.0 """ - def __init__(self, cls_method): + def __init__(self, cls_method) -> None: """Hold the class method.""" self.method = cls_method self.__doc__ = self.method.__doc__ @@ -150,7 +150,7 @@ .. versionadded:: 3.0 """ - def __init__(self, message='', category=Warning, filename=''): + def __init__(self, message='', category=Warning, filename='') -> None: """Initialize the object. The parameter semantics are similar to those of @@ -172,11 +172,11 @@ self.filename_match = re.compile(filename).match super().__init__(record=True) - def __enter__(self): + def __enter__(self) -> None: """Catch all warnings and store them in `self.log`.""" self.log = super().__enter__() - def __exit__(self, exc_type, exc_val, exc_tb): + def __exit__(self, exc_type, exc_val, exc_tb) -> None: """Stop logging warnings and show those that do not match to params.""" super().__exit__(exc_type, exc_val, exc_tb) for warning in self.log: @@ -269,7 +269,7 @@ .. versionadded:: 6.1 """ - def __init__(self, keyattr: str): + def __init__(self, keyattr: str) -> None: """Initializer. :param keyattr: an attribute or method of the values to be hold @@ -301,7 +301,7 @@ def __repr__(self) -> str: return str(self.data).replace('defaultdict', self.__class__.__name__) - def append(self, value): + def append(self, value) -> None: """Add a value to the collection.""" key = getattr(value, self.keyattr) if callable(key): @@ -311,7 +311,7 @@ self.data[key].append(value) self.size += 1 - def remove(self, value): + def remove(self, value) -> None: """Remove a value from the container.""" key = getattr(value, self.keyattr) if callable(key): @@ -320,13 +320,13 @@ self.data[key].remove(value) self.size -= 1 - def remove_key(self, key): + def remove_key(self, key) -> None: """Remove all values for a given key.""" with suppress(KeyError): self.size -= len(self.data[key]) del self.data[key] - def clear(self): + def clear(self) -> None: """Remove all elements from SizedKeyCollection.""" self.data = {} # defaultdict fails (T282865) self.size = 0 @@ -545,7 +545,7 @@ .. versionadded:: 6.2 """ - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" self._lock = threading.RLock(*args, **kwargs) self._block = threading.Lock() @@ -644,11 +644,11 @@ except KeyboardInterrupt: self.stop() - def stop(self): + def stop(self) -> None: """Stop the background thread.""" self.finished.set() - def run(self): + def run(self) -> None: """Run the generator and store the results on the queue.""" iterable = any(hasattr(self.generator, key) for key in ('__iter__', '__getitem__')) @@ -788,7 +788,7 @@ debug("thread {} ('{}') started".format(len(self), type(thd)), self._logger) - def stop_all(self): + def stop_all(self) -> None: """Stop all threads the pool.""" if self: debug('EARLY QUIT: Threads: {}'.format(len(self)), self._logger) @@ -981,12 +981,12 @@ if not add: if hasattr(container, 'add'): - def container_add(x): + def container_add(x) -> None: container.add(key(x) if key else x) add = container_add else: - def container_setitem(x): + def container_setitem(x) -> None: container.__setitem__(key(x) if key else x, True) @@ -1026,7 +1026,7 @@ ``empty_iterator()`` was removed in favour of ``iter()``. """ - def __init__(self): + def __init__(self) -> None: """Initialise the default as an empty string.""" str.__init__(self) diff --git a/pywikibot/tools/_deprecate.py b/pywikibot/tools/_deprecate.py index 3ae19d7..87d2135 100644 --- a/pywikibot/tools/_deprecate.py +++ b/pywikibot/tools/_deprecate.py @@ -43,7 +43,7 @@ """ -def add_decorated_full_name(obj, stacklevel=1): +def add_decorated_full_name(obj, stacklevel=1) -> None: """Extract full object name, including class, and store in __full_name__. This must be done on all decorators that are chained together, otherwise @@ -68,7 +68,7 @@ obj.__full_name__ = '{}.{}'.format(obj.__module__, obj.__name__) -def manage_wrapping(wrapper, obj): +def manage_wrapping(wrapper, obj) -> None: """Add attributes to wrapper and wrapped functions. .. versionadded:: 3.0 @@ -185,7 +185,7 @@ def issue_deprecation_warning(name: str, instead: str = '', depth: int = 2, - warning_class=None, since: str = ''): + warning_class=None, since: str = '') -> None: """Issue a deprecation warning. .. versionchanged:: 7.0 @@ -244,7 +244,7 @@ warning_class=None if future_warning else DeprecationWarning) return obj(*args, **kwargs) - def add_docstring(wrapper): + def add_docstring(wrapper) -> None: """Add a Deprecated notice to the docstring.""" deprecation_notice = 'Deprecated' if instead: @@ -552,7 +552,7 @@ """A wrapper for a module to deprecate classes or variables of it.""" - def __init__(self, module): + def __init__(self, module) -> None: """ Initialise the wrapper. @@ -627,7 +627,7 @@ self._deprecated[name] = ( replacement_name, replacement, warning_message, future_warning) - def __setattr__(self, attr, value): + def __setattr__(self, attr, value) -> None: """Set the value of the wrapped module.""" self.__dict__[attr] = value setattr(self._module, attr, value) diff --git a/pywikibot/tools/djvu.py b/pywikibot/tools/djvu.py index 012478f..cfc1c80 100644 --- a/pywikibot/tools/djvu.py +++ b/pywikibot/tools/djvu.py @@ -56,7 +56,7 @@ """ - def __init__(self, file: str): + def __init__(self, file: str) -> None: """ Initializer. diff --git a/pywikibot/tools/formatter.py b/pywikibot/tools/formatter.py index a3375b3..4f81afd 100644 --- a/pywikibot/tools/formatter.py +++ b/pywikibot/tools/formatter.py @@ -37,7 +37,7 @@ prefix = '\n' suffix = '\n' - def __init__(self, sequence): + def __init__(self, sequence) -> None: """Create a new instance with a reference to the sequence.""" super().__init__() self.sequence = sequence @@ -60,7 +60,7 @@ content = '' return self.prefix + content + self.suffix - def output(self): + def output(self) -> None: """Output the text of the current sequence.""" output(self.out) diff --git a/pywikibot/userinterfaces/_interface_base.py b/pywikibot/userinterfaces/_interface_base.py index 0a966cd..14eb2b6 100644 --- a/pywikibot/userinterfaces/_interface_base.py +++ b/pywikibot/userinterfaces/_interface_base.py @@ -31,14 +31,14 @@ """ return list(sys.argv) - def flush(self): + def flush(self) -> None: """Flush cached output. May be passed to atexit.register() to flush any ui cache. """ @abstractmethod - def init_handlers(self, *args, **kwargs): + def init_handlers(self, *args, **kwargs) -> None: """Initialize the handlers for user output. Called in bot.init_handlers(). diff --git a/pywikibot/userinterfaces/buffer_interface.py b/pywikibot/userinterfaces/buffer_interface.py index ac9795d..0c1b675 100755 --- a/pywikibot/userinterfaces/buffer_interface.py +++ b/pywikibot/userinterfaces/buffer_interface.py @@ -17,7 +17,7 @@ """Collects output into an unseen buffer.""" - def __init__(self): + def __init__(self) -> None: """Initialize the UI.""" super().__init__() @@ -26,7 +26,7 @@ self.log_handler = logging.handlers.QueueHandler(self._buffer) self.log_handler.setLevel(VERBOSE if config.verbose_output else INFO) - def init_handlers(self, root_logger, *args, **kwargs): + def init_handlers(self, root_logger, *args, **kwargs) -> None: """Initialize the handlers for user output.""" root_logger.addHandler(self.log_handler) @@ -69,6 +69,6 @@ return output - def clear(self): + def clear(self) -> None: """Removes any buffered output.""" self.pop_output() diff --git a/pywikibot/userinterfaces/gui.py b/pywikibot/userinterfaces/gui.py index 9324f4b..cae3559 100644 --- a/pywikibot/userinterfaces/gui.py +++ b/pywikibot/userinterfaces/gui.py @@ -45,7 +45,7 @@ """ - def __init__(self, master=None, **kwargs): + def __init__(self, master=None, **kwargs) -> None: """ Initializer. @@ -100,7 +100,7 @@ Theme, 'cursor', fgBg='fg') return config - def add_bindings(self): + def add_bindings(self) -> None: """Assign key and events bindings to methods.""" # due to IDLE dependencies, this can't be called from __init__ # add key and event bindings @@ -161,7 +161,7 @@ self.see('insert') return 'break' - def remove_selection(self, event=None): + def remove_selection(self, event=None) -> None: """Perform remove operation.""" self.tag_remove('sel', '1.0', 'end') self.see('insert') @@ -253,7 +253,7 @@ self.do_highlight(found[0], found[1]) return None - def do_highlight(self, start, end): + def do_highlight(self, start, end) -> None: """Select and show the text from index start to index end.""" self.see(start) self.tag_remove(tkinter.SEL, '1.0', tkinter.END) @@ -278,7 +278,7 @@ """Edit box window.""" - def __init__(self, parent=None, **kwargs): + def __init__(self, parent=None, **kwargs) -> None: """Initializer.""" if parent is None: # create a new window @@ -405,23 +405,23 @@ self.parent.mainloop() return self.text - def find_all(self, target): + def find_all(self, target) -> None: """Perform find all operation.""" self.textfield.insert(tkinter.END, target) self.editbox.find_all(target) - def find(self): + def find(self) -> None: """Perform find operation.""" # get text to search for s = self.textfield.get() if s: self.editbox.find_all(s) - def config_dialog(self, event=None): + def config_dialog(self, event=None) -> None: """Show config dialog.""" ConfigDialog(self, 'Settings') - def pressedOK(self): + def pressedOK(self) -> None: """ Perform OK operation. @@ -444,7 +444,7 @@ # called when user pushes the OK button. # closes the window. - def pressedOK(self): + def pressedOK(self) -> None: """ Perform OK operation. @@ -452,7 +452,7 @@ """ self.parent.destroy() - def __init__(self, parent=None): + def __init__(self, parent=None) -> None: """Initializer.""" if parent is None: # create a new window @@ -495,7 +495,7 @@ """The dialog window for image info.""" - def __init__(self, photo_description, photo, filename): + def __init__(self, photo_description, photo, filename) -> None: """Initializer.""" self.root = tkinter.Tk() # "%dx%d%+d%+d" % (width, height, xoffset, yoffset) @@ -583,13 +583,13 @@ imageTk = ImageTk.PhotoImage(image) return imageTk - def ok_file(self): + def ok_file(self) -> None: """The user pressed the OK button.""" self.filename = self.filename_field.get() self.photo_description = self.description_field.get(0.0, tkinter.END) self.root.destroy() - def skip_file(self): + def skip_file(self) -> None: """The user pressed the Skip button.""" self.skip = True self.root.destroy() diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py index eb1808f..8909aa7 100755 --- a/pywikibot/userinterfaces/terminal_interface_base.py +++ b/pywikibot/userinterfaces/terminal_interface_base.py @@ -65,7 +65,7 @@ split_col_pat = re.compile(r'(\w+);?(\w+)?') - def __init__(self): + def __init__(self) -> None: """ Initialize the UI. @@ -81,7 +81,7 @@ self.cache = [] self.lock = RLock() - def init_handlers(self, root_logger, default_stream='stderr'): + def init_handlers(self, root_logger, default_stream='stderr') -> None: """Initialize the handlers for user output. This method initializes handler(s) for output levels VERBOSE (if @@ -141,7 +141,7 @@ """ return cls.split_col_pat.search(color).groups() - def _write(self, text, target_stream): + def _write(self, text, target_stream) -> None: """Optionally encode and write the text to the target stream.""" target_stream.write(text) @@ -149,7 +149,7 @@ """Return whether the target stream does support colors.""" return False - def _print(self, text, target_stream): + def _print(self, text, target_stream) -> None: """Write the text to the target stream handling the colors.""" colorized = (config.colorized_output and self.support_color(target_stream)) @@ -188,7 +188,7 @@ # set the new color, but only if they change self.encounter_color(color_stack[-1], target_stream) - def output(self, text, targetStream=None): + def output(self, text, targetStream=None) -> None: """Forward text to cache and flush if output is not locked. All input methods locks the output to a stream but collect them @@ -202,7 +202,7 @@ if not self.lock.locked(): self.flush() - def flush(self): + def flush(self) -> None: """Output cached text. .. versionadded:: 7.0 @@ -212,7 +212,7 @@ self.stream_output(*args, **kwargs) self.cache.clear() - def cache_output(self, *args, **kwargs): + def cache_output(self, *args, **kwargs) -> None: """Put text to cache. .. versionadded:: 7.0 @@ -220,7 +220,7 @@ with self.lock: self.cache.append((args, kwargs)) - def stream_output(self, text, targetStream=None): + def stream_output(self, text, targetStream=None) -> None: """Output text to a stream. If a character can't be displayed in the encoding used by the user's @@ -388,7 +388,7 @@ default (if it's not None). Otherwise the index of the answer in options. If default is not a shortcut, it'll return -1. """ - def output_option(option, before_question): + def output_option(option, before_question) -> None: """Print an OutputOption before or after question.""" if isinstance(option, OutputOption) \ and option.before_question is before_question: @@ -523,7 +523,7 @@ # create a class-level lock that can be shared by all instances sharedlock = threading.RLock() - def __init__(self, UI, stream=None): + def __init__(self, UI, stream=None) -> None: """Initialize the handler. If stream is not specified, sys.stderr is used. @@ -531,7 +531,7 @@ super().__init__(stream=stream) self.UI = UI - def createLock(self): + def createLock(self) -> None: """Acquire a thread lock for serializing access to the underlying I/O. Replace Handler's instance-specific lock with the shared @@ -540,7 +540,7 @@ """ self.lock = TerminalHandler.sharedlock - def emit(self, record): + def emit(self, record) -> None: """Emit the record formatted to the output.""" self.flush() if record.name == 'py.warnings': @@ -564,7 +564,7 @@ """ - def __init__(self, level=None): + def __init__(self, level=None) -> None: """Initializer.""" self.level = level diff --git a/pywikibot/userinterfaces/terminal_interface_unix.py b/pywikibot/userinterfaces/terminal_interface_unix.py index 8d82f32..2a56196 100755 --- a/pywikibot/userinterfaces/terminal_interface_unix.py +++ b/pywikibot/userinterfaces/terminal_interface_unix.py @@ -43,7 +43,7 @@ code = re.search(r'(?<=\[)\d+', color).group() return chr(27) + '[' + str(int(code) + 10) + 'm' - def encounter_color(self, color, target_stream): + def encounter_color(self, color, target_stream) -> None: """Write the Unix color directly to the stream.""" fg, bg = self.divide_color(color) fg = unixColors[fg] @@ -52,6 +52,6 @@ bg = unixColors[bg] self._write(self.make_unix_bg_color(bg), target_stream) - def _write(self, text, target_stream): + def _write(self, text, target_stream) -> None: """Optionally encode and write the text to the target stream.""" target_stream.write(text) diff --git a/pywikibot/userinterfaces/terminal_interface_win32.py b/pywikibot/userinterfaces/terminal_interface_win32.py index 05b62eb..1a0ef51 100755 --- a/pywikibot/userinterfaces/terminal_interface_win32.py +++ b/pywikibot/userinterfaces/terminal_interface_win32.py @@ -34,7 +34,7 @@ """User interface for Win32 terminals.""" - def __init__(self): + def __init__(self) -> None: """Initializer.""" super().__init__() (stdin, stdout, stderr, argv) = win32_unicode.get_unicode_console() @@ -48,7 +48,7 @@ """Return whether the target stream supports actually color.""" return getattr(target_stream, '_hConsole', None) is not None - def encounter_color(self, color, target_stream): + def encounter_color(self, color, target_stream) -> None: """Set the new color.""" fg, bg = self.divide_color(color) windows_color = windowsColors[fg] diff --git a/pywikibot/userinterfaces/transliteration.py b/pywikibot/userinterfaces/transliteration.py index 9e63800..d7bb3a0 100644 --- a/pywikibot/userinterfaces/transliteration.py +++ b/pywikibot/userinterfaces/transliteration.py @@ -1085,7 +1085,7 @@ """Class to transliterating text.""" - def __init__(self, encoding: str): + def __init__(self, encoding: str) -> None: """ Initialize the transliteration mapping. diff --git a/pywikibot/userinterfaces/win32_unicode.py b/pywikibot/userinterfaces/win32_unicode.py index cbc4864..6242832 100755 --- a/pywikibot/userinterfaces/win32_unicode.py +++ b/pywikibot/userinterfaces/win32_unicode.py @@ -67,7 +67,7 @@ """Unicode terminal input class.""" - def __init__(self, hConsole, name, bufsize=1024): + def __init__(self, hConsole, name, bufsize=1024) -> None: """Initialize the input stream.""" self._hConsole = hConsole self.bufsize = bufsize @@ -90,7 +90,7 @@ """Unicode terminal output class.""" - def __init__(self, hConsole, stream, fileno, name): + def __init__(self, hConsole, stream, fileno, name) -> None: """Initialize the output stream.""" self._hConsole = hConsole self._stream = stream @@ -169,12 +169,12 @@ # which makes for frustrating debugging if stderr is directed to our wrapper. # So be paranoid about catching errors and reporting them to original_stderr, # so that we can at least see them. -def _complain(message): +def _complain(message) -> None: print(isinstance(message, str) and message or repr(message), file=original_stderr) -def force_truetype_console(h_stdout): +def force_truetype_console(h_stdout) -> None: """Force the console to use a TrueType font (Vista+).""" TMPF_TRUETYPE = 0x04 LF_FACESIZE = 32 diff --git a/pywikibot/xmlreader.py b/pywikibot/xmlreader.py index 6a03e8b..9b57a19 100644 --- a/pywikibot/xmlreader.py +++ b/pywikibot/xmlreader.py @@ -49,7 +49,7 @@ def __init__(self, title, ns, id, text, username, ipedit, timestamp, editRestriction, moveRestriction, revisionid, comment, - redirect): + redirect) -> None: """Initializer.""" # TODO: there are more tags we can read. self.title = title @@ -78,13 +78,13 @@ There surely are more elegant ways to do this. """ - def __init__(self, filename, handler): + def __init__(self, filename, handler) -> None: """Initializer.""" super().__init__() self.filename = filename self.handler = handler - def run(self): + def run(self) -> None: """Parse the file in a single thread.""" xml.sax.parse(self.filename, self.handler) @@ -102,7 +102,7 @@ Default: False. """ - def __init__(self, filename, allrevisions=False): + def __init__(self, filename, allrevisions=False) -> None: """Initializer.""" self.filename = filename if allrevisions: @@ -143,7 +143,7 @@ elem.clear() self.root.clear() - def _headers(self, elem): + def _headers(self, elem) -> None: """Extract headers from XML chunk.""" self.title = elem.findtext('{%s}title' % self.uri) self.ns = elem.findtext('{%s}ns' % self.uri) diff --git a/scripts/add_text.py b/scripts/add_text.py index 903c6a5..e850f73 100755 --- a/scripts/add_text.py +++ b/scripts/add_text.py @@ -117,7 +117,7 @@ text = re.sub(r'\r?\n', ' - ', self.opt.text[:200]) return {'adding': text} - def setup(self): + def setup(self) -> None: """Read text to be added from file.""" if self.opt.textfile: with codecs.open(self.opt.textfile, 'r', @@ -159,7 +159,7 @@ return super().skip_page(page) - def treat_page(self): + def treat_page(self) -> None: """Add text to the page.""" text = self.current_page.text diff --git a/scripts/blockpageschecker.py b/scripts/blockpageschecker.py index e72f9b1..b1ce7e1 100755 --- a/scripts/blockpageschecker.py +++ b/scripts/blockpageschecker.py @@ -184,7 +184,7 @@ 'move': False, } - def invoke_editor(self, page): + def invoke_editor(self, page) -> None: """Ask for an editor and invoke it.""" choice = pywikibot.input_choice( 'Do you want to open the page?', @@ -195,16 +195,16 @@ editor = TextEditor() editor.edit(page.text) - def setup(self): + def setup(self) -> None: """Initialize the coroutine for parsing templates.""" self.parse_tempates = self.remove_templates() self.parse_tempates.send(None) - def teardown(self): + def teardown(self) -> None: """Close the coroutine.""" self.parse_tempates.close() - def treat_page(self): + def treat_page(self) -> None: """Load the given page, do some changes, and save it.""" page = self.current_page if page.isRedirectPage(): diff --git a/scripts/category.py b/scripts/category.py index cae9495..ef138cd 100755 --- a/scripts/category.py +++ b/scripts/category.py @@ -188,7 +188,7 @@ """A class to prepare a list of pages for robots.""" def __init__(self, follow_redirects=False, edit_redirects=False, - create=False, **kwargs): + create=False, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) self.follow_redirects = follow_redirects diff --git a/scripts/category_redirect.py b/scripts/category_redirect.py index 4089cb3..2b542ae 100755 --- a/scripts/category_redirect.py +++ b/scripts/category_redirect.py @@ -63,7 +63,7 @@ 'delay': 7, # cool down delay in days } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) self.catprefix = self.site.namespace(14) + ':' @@ -211,7 +211,7 @@ log_text += ('\n\n' + message) return log_text - def check_hard_redirect(self): + def check_hard_redirect(self) -> None: """ Check for hard-redirected categories. @@ -270,7 +270,7 @@ self.site, 'category_redirect-log-add-failed', params) self.log_text.append(message) - def run(self): + def run(self) -> None: """Run the bot.""" # validate L10N self.template_list = self.site.category_redirects() @@ -451,7 +451,7 @@ self.teardown() - def teardown(self): + def teardown(self) -> None: """Write self.record to file and save logs.""" with open(self.datafile, 'wb') as f: pickle.dump(self.record, f, protocol=config.pickle_protocol) diff --git a/scripts/change_pagelang.py b/scripts/change_pagelang.py index a8fb485..ea205cb 100755 --- a/scripts/change_pagelang.py +++ b/scripts/change_pagelang.py @@ -49,13 +49,13 @@ 'setlang': '', } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) assert not (self.opt.always and self.opt.never), \ 'Either "always" or "never" must be set but not both' - def changelang(self, page): + def changelang(self, page) -> None: """Set page language. :param page: The page to update and save @@ -73,7 +73,7 @@ 'page language to {green}{1}{default}', page.title(as_link=True), self.opt.setlang)) - def treat(self, page): + def treat(self, page) -> None: """Treat a page. :param page: The page to treat diff --git a/scripts/commons_information.py b/scripts/commons_information.py index 1367448..baa2637 100755 --- a/scripts/commons_information.py +++ b/scripts/commons_information.py @@ -36,7 +36,7 @@ 'appropriate language template') } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initialzer.""" super().__init__(**kwargs) lang_tmp_cat = pywikibot.Category(self.site, self.lang_tmp_cat) @@ -95,7 +95,7 @@ return False @staticmethod - def replace_value(param, value): + def replace_value(param, value) -> None: """Replace param with given value.""" lstrip = param.value.lstrip() lspaces = param.value[:len(param.value) - len(lstrip)] @@ -107,7 +107,7 @@ if isinstance(mwparserfromhell, Exception): raise mwparserfromhell - def treat_page(self): + def treat_page(self) -> None: """Treat current page.""" page = self.current_page code = mwparserfromhell.parse(page.text) diff --git a/scripts/commonscat.py b/scripts/commonscat.py index 8149224..b58b6ab 100755 --- a/scripts/commonscat.py +++ b/scripts/commonscat.py @@ -269,7 +269,7 @@ return True return False - def treat_page(self): + def treat_page(self) -> None: """ Add CommonsCat template to page. @@ -333,7 +333,7 @@ def changeCommonscat( self, page=None, oldtemplate='', oldcat='', - newtemplate='', newcat='', linktitle=''): + newtemplate='', newcat='', linktitle='') -> None: """Change the current commonscat template and target.""" if '3=S' in (oldcat, linktitle): return # TODO: handle additional param on de-wiki diff --git a/scripts/data_ingestion.py b/scripts/data_ingestion.py index 084e252..b276e37 100755 --- a/scripts/data_ingestion.py +++ b/scripts/data_ingestion.py @@ -120,7 +120,7 @@ """Represents a Photo (or other file), with metadata, to be uploaded.""" def __init__(self, url: str, metadata: Dict[str, Any], - site: Optional[pywikibot.site.APISite] = None): + site: Optional[pywikibot.site.APISite] = None) -> None: """ Initializer. @@ -216,7 +216,7 @@ """Data ingestion bot.""" - def __init__(self, titlefmt: str, pagefmt: str, **kwargs): + def __init__(self, titlefmt: str, pagefmt: str, **kwargs) -> None: """ Initializer. @@ -227,7 +227,7 @@ self.titlefmt = titlefmt self.pagefmt = pagefmt - def treat(self, page): + def treat(self, page) -> None: """Process each page. 1. Check for existing duplicates on the wiki specified in self.site. @@ -282,7 +282,7 @@ return configuration -def main(*args: str): +def main(*args: str) -> None: """ Process command line arguments and invoke bot. diff --git a/scripts/djvutext.py b/scripts/djvutext.py index 638ea06..509ddeb 100755 --- a/scripts/djvutext.py +++ b/scripts/djvutext.py @@ -63,7 +63,13 @@ 'summary': '', } - def __init__(self, djvu, index, pages: Optional[tuple] = None, **kwargs): + def __init__( + self, + djvu, + index, + pages: Optional[tuple] = None, + **kwargs + ) -> None: """ Initializer. @@ -109,7 +115,7 @@ page.page_number = page_number # remember page number in djvu file yield page - def treat(self, page): + def treat(self, page) -> None: """Process one page.""" old_text = page.text diff --git a/scripts/download_dump.py b/scripts/download_dump.py index e33d4cf..53062e6 100755 --- a/scripts/download_dump.py +++ b/scripts/download_dump.py @@ -70,7 +70,7 @@ return dump_filepath return None - def run(self): + def run(self) -> None: """Run bot.""" def convert_from_bytes(total_bytes): for unit in ['B', 'K', 'M', 'G', 'T']: diff --git a/scripts/fixing_redirects.py b/scripts/fixing_redirects.py index 12d111a..8707595 100755 --- a/scripts/fixing_redirects.py +++ b/scripts/fixing_redirects.py @@ -191,7 +191,7 @@ target = None return page, target - def treat_page(self): + def treat_page(self) -> None: """Change all redirects from the current page to actual links.""" try: newtext = self.current_page.text diff --git a/scripts/imagetransfer.py b/scripts/imagetransfer.py index c25e8bc..3f60988 100755 --- a/scripts/imagetransfer.py +++ b/scripts/imagetransfer.py @@ -152,7 +152,7 @@ 'chunk_size': 0, } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer. :keyword generator: the pages to work on @@ -179,7 +179,7 @@ else: self.opt.target = pywikibot.Site(self.opt.target) - def transfer_image(self, sourceImagePage): + def transfer_image(self, sourceImagePage) -> None: """ Download image and its description, and upload it to another site. @@ -257,7 +257,7 @@ % target_filename, summary=reason) - def show_image_list(self, imagelist): + def show_image_list(self, imagelist) -> None: """Print image list.""" pywikibot.output('-' * 60) for i, image in enumerate(imagelist): @@ -292,7 +292,7 @@ pywikibot.output('=' * 60) - def treat(self, page): + def treat(self, page) -> None: """Treat a single page.""" if self.opt.interwiki: imagelist = [] diff --git a/scripts/interwiki.py b/scripts/interwiki.py index 7696438..fff4d5c 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -458,7 +458,7 @@ summary = '' repository = False - def note(self, text): + def note(self, text) -> None: """Output a notification message with. The text will be printed only if conf.quiet isn't set. @@ -622,7 +622,7 @@ this Object. """ - def __init__(self, origin=None, hints=None, conf=None): + def __init__(self, origin=None, hints=None, conf=None) -> None: """ Initializer. @@ -710,7 +710,7 @@ return page return None - def translate(self, hints=None, keephintedsites=False): + def translate(self, hints=None, keephintedsites=False) -> None: """Add the given translation hints to the todo list.""" if self.conf.same and self.origin: if hints: @@ -772,7 +772,7 @@ # If there are any, return them. Otherwise, nothing is in progress. return result - def makeForcedStop(self, counter): + def makeForcedStop(self, counter) -> None: """End work on the page before the normal end.""" for site, count in self.todo.iter_values_len(): counter.minus(site, count) @@ -1013,7 +1013,7 @@ return False - def reportInterwikilessPage(self, page): + def reportInterwikilessPage(self, page) -> None: """Report interwikiless page.""" self.conf.note('{} does not have any interwiki links' .format(self.origin)) @@ -1023,7 +1023,7 @@ 'a', 'utf-8') as f: f.write('# {} \n'.format(page)) - def askForHints(self, counter): + def askForHints(self, counter) -> None: """Ask for hints to other sites.""" if (not self.workonme # we don't work on it anyway or not self.untranslated and not self.conf.askhints @@ -1067,7 +1067,7 @@ if self.conf.hintsareright: self.hintedsites.add(page.site) - def check_page(self, page, counter): + def check_page(self, page, counter) -> None: """Check whether any iw links should be added to the todo list.""" if not page.exists(): self.conf.remove.append(str(page)) @@ -1245,7 +1245,7 @@ if self.forcedStop: break - def batchLoaded(self, counter): + def batchLoaded(self, counter) -> None: """ Notify that the promised batch of pages was loaded. @@ -1296,14 +1296,14 @@ """Return True if all the work for this subject has completed.""" return not self.todo - def problem(self, txt, createneed=True): + def problem(self, txt, createneed=True) -> None: """Report a problem with the resolution of this subject.""" pywikibot.error(txt) self.confirm = True if createneed: self.problemfound = True - def whereReport(self, page, indent=4): + def whereReport(self, page, indent=4) -> None: """Report found interlanguage links with conflicts.""" for page2 in sorted(self.found_in[page]): if page2 is None: @@ -1776,7 +1776,7 @@ break return True - def reportBacklinks(self, new, updatedSites): + def reportBacklinks(self, new, updatedSites) -> None: """ Report missing back links. This will be called from finish() if needed. @@ -1845,7 +1845,7 @@ It controls which pages are queried from which languages when. """ - def __init__(self, conf=None): + def __init__(self, conf=None) -> None: """Initializer.""" self.subjects = [] # We count how many pages still need to be loaded per site. @@ -1859,7 +1859,7 @@ self.conf = conf self.site = pywikibot.Site() - def add(self, page, hints=None): + def add(self, page, hints=None) -> None: """Add a single subject to the list.""" subj = Subject(page, hints=hints, conf=self.conf) self.subjects.append(subj) @@ -1867,7 +1867,7 @@ # Keep correct counters self.plus(site, count) - def setPageGenerator(self, pageGenerator, number=None, until=None): + def setPageGenerator(self, pageGenerator, number=None, until=None) -> None: """ Add a generator of subjects. @@ -1883,7 +1883,7 @@ """Return generator of titles for dump file.""" return (s.origin.title(as_link=True) for s in self.subjects) - def generateMore(self, number): + def generateMore(self, number) -> None: """Generate more subjects. This is called internally when the @@ -2054,7 +2054,7 @@ subject.batchLoaded(self) return True - def queryStep(self): + def queryStep(self) -> None: """Delete the ones that are done now.""" self.oneQuery() for i in range(len(self.subjects) - 1, -1, -1): @@ -2067,16 +2067,16 @@ """Check whether there is still more work to do.""" return not self and self.pageGenerator is None - def plus(self, site, count=1): + def plus(self, site, count=1) -> None: """Helper routine that the Subject class expects in a counter.""" self.counts[site] += count - def minus(self, site, count=1): + def minus(self, site, count=1) -> None: """Helper routine that the Subject class expects in a counter.""" self.counts[site] -= count self.counts = +self.counts # remove zero and negative counts - def run(self): + def run(self) -> None: """Start the process until finished.""" while not self.isDone(): self.queryStep() @@ -2199,7 +2199,7 @@ FILE_PATTERN = '{site.family.name}-{site.code}.txt' - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer. :keyword do_continue: If true, continue alphabetically starting at the @@ -2225,7 +2225,7 @@ """Return next page namespace for continue option.""" return self._next_namespace - def remove(self, filename: str): + def remove(self, filename: str) -> None: """Remove filename from restored files. :param filename: A filename to be removed from restored set. @@ -2278,7 +2278,7 @@ namespace=self.next_namespace, filterredir=False) - def write_dump(self, iterable, append: bool = True): + def write_dump(self, iterable, append: bool = True) -> None: """Write dump file. :param iterable: an iterable of page titles to be dumped. @@ -2296,7 +2296,7 @@ .format(site=self.site, mode=mode)) self.remove(filename) - def delete_dumps(self): + def delete_dumps(self) -> None: """Delete processed dumps.""" for filename in self.restored_files: tail = os.path.split(filename)[-1] diff --git a/scripts/movepages.py b/scripts/movepages.py index dcacaff..75f4536 100755 --- a/scripts/movepages.py +++ b/scripts/movepages.py @@ -91,7 +91,7 @@ return True return super().skip_page(page) - def treat_page(self): + def treat_page(self) -> None: """Treat a single page.""" page = self.current_page pagetitle = page.title(with_ns=False) diff --git a/scripts/nowcommons.py b/scripts/nowcommons.py index bbb9038..9ec0557 100755 --- a/scripts/nowcommons.py +++ b/scripts/nowcommons.py @@ -188,7 +188,7 @@ 'replaceonly': False, } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) self.site = pywikibot.Site() @@ -257,7 +257,7 @@ file_on_commons = val[1].strip() return file_on_commons - def run(self): + def run(self) -> None: """Run the bot.""" commons = self.commons comment = self.summary diff --git a/scripts/pagefromfile.py b/scripts/pagefromfile.py index f5dff52..0a439d3 100755 --- a/scripts/pagefromfile.py +++ b/scripts/pagefromfile.py @@ -83,7 +83,7 @@ """No title found.""" - def __init__(self, offset): + def __init__(self, offset) -> None: """Initializer.""" self.offset = offset diff --git a/scripts/parser_function_count.py b/scripts/parser_function_count.py index 08ce8d9..5cdc4cd 100755 --- a/scripts/parser_function_count.py +++ b/scripts/parser_function_count.py @@ -77,7 +77,7 @@ 'upload': None, } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) editcomment = { @@ -121,7 +121,7 @@ gen, self.site.doc_subpage, quantifier='none') return gen - def setup(self): + def setup(self) -> None: """Setup magic words, regex and result counter.""" pywikibot.output('Hold on, this will need some time. ' 'You will be notified by 50 templates.') @@ -131,7 +131,7 @@ self.regex = re.compile(r'#({}):'.format('|'.join(magicwords)), re.I) self.results = Counter() - def treat(self, page): + def treat(self, page) -> None: """Process a single template.""" title = page.title() if (self.counter['read'] + 1) % 50 == 0: @@ -149,7 +149,7 @@ and len(self.results) >= self.opt.first: self.stop() - def teardown(self): + def teardown(self) -> None: """Final processing.""" resultlist = '\n'.join( '# [[{result[0]}]] ({result[1]})' diff --git a/scripts/patrol.py b/scripts/patrol.py index 80959e3..3dacb6f 100755 --- a/scripts/patrol.py +++ b/scripts/patrol.py @@ -64,7 +64,7 @@ _logger = 'patrol' -def verbose_output(string): +def verbose_output(string) -> None: """Verbose output.""" if pywikibot.config.verbose_output: pywikibot.output(string) @@ -85,7 +85,7 @@ 'en': 'patrol_whitelist', } - def __init__(self, site=None, **kwargs): + def __init__(self, site=None, **kwargs) -> None: """ Initializer. @@ -335,7 +335,7 @@ """Matches of page site title and linked pages title.""" - def __init__(self, page_title: str): + def __init__(self, page_title: str) -> None: """Initializer. :param page_title: The page title for this rule diff --git a/scripts/protect.py b/scripts/protect.py index a65fb4b..a01947a 100755 --- a/scripts/protect.py +++ b/scripts/protect.py @@ -84,7 +84,7 @@ 'expiry': '', } - def __init__(self, protections, **kwargs): + def __init__(self, protections, **kwargs) -> None: """ Create a new ProtectionRobot. @@ -95,7 +95,7 @@ super().__init__(**kwargs) self.protections = protections - def treat_page(self): + def treat_page(self) -> None: """Run the bot's action on each page. treat_page treats every page given by the generator and applies diff --git a/scripts/redirect.py b/scripts/redirect.py index 9f71e8a..c928e08 100755 --- a/scripts/redirect.py +++ b/scripts/redirect.py @@ -124,7 +124,7 @@ 'xml': None, } - def __init__(self, action, **kwargs): + def __init__(self, action, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) self.site = pywikibot.Site() diff --git a/scripts/reflinks.py b/scripts/reflinks.py index 5b4183e..d42ce0d 100755 --- a/scripts/reflinks.py +++ b/scripts/reflinks.py @@ -210,7 +210,7 @@ """Container to handle a single bare reference.""" - def __init__(self, link, name, site=None): + def __init__(self, link, name, site=None) -> None: """Initializer.""" self.name = name self.link = link @@ -239,7 +239,7 @@ dead_link = '<ref{}>{}</ref>'.format(self.name, tag) return dead_link - def transform(self, ispdf=False): + def transform(self, ispdf=False) -> None: """Normalize the title.""" # convert html entities if not ispdf: @@ -263,7 +263,7 @@ self.title = string2html(self.title, self.site.encoding()) # TODO : remove HTML when both opening and closing tags are included - def avoid_uppercase(self): + def avoid_uppercase(self) -> None: """ Convert to title()-case if title is 70% uppercase characters. @@ -302,7 +302,7 @@ name the first, and remove the content of the others """ - def __init__(self, site=None): + def __init__(self, site=None) -> None: """Initializer.""" if not site: site = pywikibot.Site() @@ -438,7 +438,7 @@ 'summary': '', } - def __init__(self, **kwargs): + def __init__(self, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) self._use_fake_user_agent = config.fake_user_agent_default.get( @@ -494,12 +494,12 @@ self.MIME = re.compile( r'application/(?:xhtml\+xml|xml)|text/(?:ht|x)ml') - def httpError(self, err_num, link, pagetitleaslink): + def httpError(self, err_num, link, pagetitleaslink) -> None: """Log HTTP Error.""" pywikibot.stdout('HTTP error ({}) for {} on {}' .format(err_num, link, pagetitleaslink)) - def getPDFTitle(self, ref, response): + def getPDFTitle(self, ref, response) -> None: """Use pdfinfo to retrieve title from a PDF.""" # pdfinfo is Unix-only pywikibot.output('Reading PDF file...') @@ -551,7 +551,7 @@ return True return super().skip_page(page) - def treat(self, page): + def treat(self, page) -> None: """Process one page.""" # Load the page's text from the wiki new_text = page.text diff --git a/scripts/replace.py b/scripts/replace.py index 2413c25..035ba41 100755 --- a/scripts/replace.py +++ b/scripts/replace.py @@ -164,7 +164,7 @@ } -def precompile_exceptions(exceptions, use_regex, flags): +def precompile_exceptions(exceptions, use_regex, flags) -> None: """Compile the exceptions with the given flags.""" if not exceptions: return @@ -187,7 +187,13 @@ """The replacement instructions.""" - def __init__(self, old, new, edit_summary=None, default_summary=True): + def __init__( + self, + old, + new, + edit_summary=None, + default_summary=True + ) -> None: """Create a basic replacement instance.""" self.old = old self.old_regex = None @@ -225,7 +231,7 @@ """ return None - def _compile(self, use_regex, flags): + def _compile(self, use_regex, flags) -> None: """Compile the search text without modifying the flags.""" # This does not update use_regex and flags depending on this instance if not use_regex: @@ -234,7 +240,7 @@ self.old_regex = self.old self.old_regex = re.compile(self.old_regex, flags) - def compile(self, use_regex, flags): + def compile(self, use_regex, flags) -> None: """Compile the search text.""" # Set the regular expression flags if self.case_insensitive is False: @@ -253,7 +259,7 @@ def __init__(self, old, new, use_regex=None, exceptions=None, case_insensitive=None, edit_summary=None, - default_summary=True): + default_summary=True) -> None: """Create a single replacement entry unrelated to a fix.""" super().__init__(old, new, edit_summary, default_summary) self._use_regex = use_regex @@ -279,7 +285,7 @@ """Return whether the search text is using regex.""" return self._use_regex - def _compile(self, use_regex, flags): + def _compile(self, use_regex, flags) -> None: """Compile the search regex and exceptions.""" super()._compile(use_regex, flags) precompile_exceptions(self.exceptions, use_regex, flags) @@ -304,7 +310,7 @@ """ def __init__(self, use_regex, exceptions, case_insensitive, edit_summary, - name): + name) -> None: """Create a fix list which can contain multiple replacements.""" super().__init__() self.use_regex = use_regex @@ -314,7 +320,7 @@ self.edit_summary = edit_summary self.name = name - def _compile_exceptions(self, use_regex, flags): + def _compile_exceptions(self, use_regex, flags) -> None: """Compile the exceptions if not already done.""" if not self.exceptions and self._exceptions is not None: self.exceptions = dict(self._exceptions) @@ -326,7 +332,7 @@ """A replacement entry for ReplacementList.""" def __init__(self, old, new, fix_set, edit_summary=None, - default_summary=True): + default_summary=True) -> None: """Create a replacement entry inside a fix set.""" super().__init__(old, new, edit_summary, default_summary) self.fix_set = fix_set @@ -366,7 +372,7 @@ """ return self.fix_set - def _compile(self, use_regex, flags): + def _compile(self, use_regex, flags) -> None: """Compile the search regex and the fix's exceptions.""" super()._compile(use_regex, flags) self.fix_set._compile_exceptions(use_regex, flags) @@ -395,7 +401,14 @@ :type exceptions: dict """ - def __init__(self, xmlFilename, xmlStart, replacements, exceptions, site): + def __init__( + self, + xmlFilename, + xmlStart, + replacements, + exceptions, + site + ) -> None: """Initializer.""" self.xmlFilename = xmlFilename self.replacements = replacements @@ -656,7 +669,7 @@ return super().skip_page(page) - def treat(self, page): + def treat(self, page) -> None: """Work on each page retrieved from generator.""" try: original_text = page.text @@ -746,7 +759,7 @@ self.save(page, original_text, new_text, applied, show_diff=False, asynchronous=False) - def save(self, page, oldtext, newtext, applied, **kwargs): + def save(self, page, oldtext, newtext, applied, **kwargs) -> None: """Save the given page.""" self.userPut(page, oldtext, newtext, summary=self.generate_summary(applied), diff --git a/scripts/replicate_wiki.py b/scripts/replicate_wiki.py index e4dd498..8f9a516 100755 --- a/scripts/replicate_wiki.py +++ b/scripts/replicate_wiki.py @@ -62,7 +62,7 @@ """Work is done in here.""" - def __init__(self, options): + def __init__(self, options) -> None: """Initializer.""" self.options = options @@ -96,7 +96,7 @@ pywikibot.output(str(s), newline=False) pywikibot.output('') - def check_sysops(self): + def check_sysops(self) -> None: """Check if sysops are the same on all wikis.""" def get_users(site): userlist = [ul['name'] for ul in site.allusers(group='sysop')] @@ -109,7 +109,7 @@ diff.sort() self.user_diff[site] = diff - def check_namespaces(self): + def check_namespaces(self) -> None: """Check all namespaces, to be ditched for clarity.""" namespaces = [ 0, # Main @@ -131,7 +131,7 @@ for ns in namespaces: self.check_namespace(ns) - def check_namespace(self, namespace): + def check_namespace(self, namespace) -> None: """Check an entire namespace.""" pywikibot.output('\nCHECKING NAMESPACE {}'.format(namespace)) pages = (p.title() for p in self.original.allpages( @@ -149,7 +149,7 @@ 'error: Redirectpage - todo: handle gracefully') pywikibot.output('') - def generate_overviews(self): + def generate_overviews(self) -> None: """Create page on wikis with overview of bot results.""" for site in self.sites: sync_overview_page = Page(site, @@ -180,7 +180,7 @@ return ('{} replicate_wiki.py synchronization from {}' .format(site.user(), str(self.original))) - def check_page(self, pagename): + def check_page(self, pagename) -> None: """Check one page.""" pywikibot.output('\nChecking ' + pagename) page1 = Page(self.original, pagename) diff --git a/scripts/solve_disambiguation.py b/scripts/solve_disambiguation.py index fe556f0..7d2bcd8 100755 --- a/scripts/solve_disambiguation.py +++ b/scripts/solve_disambiguation.py @@ -632,7 +632,7 @@ self.summary = None self.dn_template_str = i18n.translate(self.site, dn_template) - def _clean_args(self, args, kwargs): + def _clean_args(self, args, kwargs) -> None: """Cleanup positional and keyword arguments. Replace positional arguments with keyword arguments. @@ -1255,7 +1255,7 @@ 'to': targets, 'count': len(new_targets)}) - def teardown(self): + def teardown(self) -> None: """Write ignoring pages to a file.""" self.primaryIgnoreManager.ignore(self.ignores) diff --git a/scripts/speedy_delete.py b/scripts/speedy_delete.py index ad68da2..dcbcde1 100755 --- a/scripts/speedy_delete.py +++ b/scripts/speedy_delete.py @@ -394,11 +394,11 @@ return reason or suggested_reason - def exit(self): + def exit(self) -> None: """Just call teardown after current run.""" self.teardown() - def run(self): + def run(self) -> None: """Start the bot's action.""" start_ts = pywikibot.Timestamp.now() self.saved_progress = None @@ -420,7 +420,7 @@ self._start_ts = start_ts super().exit() - def treat_page(self): + def treat_page(self) -> None: """Process one page.""" page = self.current_page @@ -464,7 +464,7 @@ else: pywikibot.output('Skipping page {}'.format(page)) - def setup(self): + def setup(self) -> None: """Refresh generator.""" generator = pagegenerators.CategorizedPageGenerator( self.csd_cat, start=self.saved_progress) diff --git a/scripts/unusedfiles.py b/scripts/unusedfiles.py index e8956b5..c891f05 100755 --- a/scripts/unusedfiles.py +++ b/scripts/unusedfiles.py @@ -104,7 +104,7 @@ 'This script is not localized for {} site;\n' 'try using -filetemplate:<template name>.'.format(self.site)) - def treat(self, image): + def treat(self, image) -> None: """Process one image page.""" # Use get_file_url() and file_is_shared() to confirm it is local media # rather than a local page with the same name as shared media. @@ -145,7 +145,7 @@ self.current_page = page self.put_current(text) - def post_to_flow_board(self, page, post): + def post_to_flow_board(self, page, post) -> None: """Post message as a Flow topic.""" board = Board(page) header, rest = post.split('\n', 1) diff --git a/scripts/watchlist.py b/scripts/watchlist.py index 5bfef5b..cbb5444 100755 --- a/scripts/watchlist.py +++ b/scripts/watchlist.py @@ -41,7 +41,7 @@ return watchlist -def count_watchlist(site=None): +def count_watchlist(site=None) -> None: """Count only the total number of page(s) in watchlist for this wiki.""" if site is None: site = pywikibot.Site() @@ -50,7 +50,7 @@ .format(watchlist_count)) -def count_watchlist_all(): +def count_watchlist_all() -> None: """Count only the total number of page(s) in watchlist for all wikis.""" wl_count_all = 0 pywikibot.output('Counting pages in watchlists of all wikis...') @@ -74,7 +74,7 @@ return list(site.watched_pages(force=True)) -def refresh_all(): +def refresh_all() -> None: """Reload watchlists for all wikis where a watchlist is already present.""" cache_path = CachedRequest._get_cache_dir() files = os.scandir(cache_path) @@ -89,7 +89,7 @@ seen.add(entry.site) -def refresh_new(): +def refresh_new() -> None: """Load watchlists of all wikis for accounts set in user-config.py.""" pywikibot.output( 'Downloading all watchlists for your accounts in user-config.py') diff --git a/scripts/weblinkchecker.py b/scripts/weblinkchecker.py index 9f11b04..f8eb86a 100755 --- a/scripts/weblinkchecker.py +++ b/scripts/weblinkchecker.py @@ -286,7 +286,7 @@ After checking the page, it will die. """ - def __init__(self, page, url, history, http_ignores, day): + def __init__(self, page, url, history, http_ignores, day) -> None: """Initializer.""" self.page = page self.url = url @@ -364,7 +364,7 @@ } """ - def __init__(self, report_thread, site=None): + def __init__(self, report_thread, site=None) -> None: """Initializer.""" self.report_thread = report_thread if not site: @@ -385,7 +385,7 @@ # no saved history exists yet, or history dump broken self.history_dict = {} - def log(self, url, error, containing_page, archive_url): + def log(self, url, error, containing_page, archive_url) -> None: """Log an error report to a text file in the deadlinks subdirectory.""" if archive_url: error_report = '* {} ([{} archive])\n'.format(url, archive_url) @@ -414,7 +414,7 @@ self.report_thread.report(url, error_report, containing_page, archive_url) - def set_dead_link(self, url, error, page, weblink_dead_days): + def set_dead_link(self, url, error, page, weblink_dead_days) -> None: """Add the fact that the link was found dead to the .dat file.""" with self.semaphore: now = time.time() @@ -456,7 +456,7 @@ return False - def save(self): + def save(self) -> None: """Save the .dat file to disk.""" with open(self.datfilename, 'wb') as f: pickle.dump(self.history_dict, f, protocol=config.pickle_protocol) @@ -471,7 +471,7 @@ sure that two LinkCheckerThreads cannot access the queue at the same time. """ - def __init__(self): + def __init__(self) -> None: """Initializer.""" super().__init__() self.semaphore = threading.Semaphore() @@ -479,22 +479,22 @@ self.finishing = False self.killed = False - def report(self, url, error_report, containing_page, archive_url): + def report(self, url, error_report, containing_page, archive_url) -> None: """Report error on talk page of the page containing the dead link.""" with self.semaphore: self.queue.append((url, error_report, containing_page, archive_url)) - def shutdown(self): + def shutdown(self) -> None: """Finish thread.""" self.finishing = True - def kill(self): + def kill(self) -> None: """Kill thread.""" # TODO: remove if unneeded self.killed = True - def run(self): + def run(self) -> None: """Run thread.""" while not self.killed: if not self.queue: @@ -567,7 +567,7 @@ It uses several LinkCheckThreads at once to process pages from generator. """ - def __init__(self, http_ignores=None, day=7, **kwargs): + def __init__(self, http_ignores=None, day=7, **kwargs) -> None: """Initializer.""" super().__init__(**kwargs) @@ -585,7 +585,7 @@ self.threads = ThreadList(limit=config.max_external_links, wait_time=config.retry_wait) - def treat_page(self): + def treat_page(self) -> None: """Process one page.""" page = self.current_page for url in weblinks_from_text(page.text): diff --git a/scripts/welcome.py b/scripts/welcome.py index 7b9b7d3..d317622 100755 --- a/scripts/welcome.py +++ b/scripts/welcome.py @@ -648,7 +648,7 @@ pywikibot.output('Reported') self.BAQueue = [] - def makelogpage(self): + def makelogpage(self) -> None: """Make log page.""" if not globalvar.make_welcome_log or not self.welcomed_users: return @@ -855,7 +855,7 @@ if welcomed_count >= globalvar.dump_to_log: self.makelogpage() - def write_log(self): + def write_log(self) -> None: """Write logfile.""" welcomed_count = len(self.welcomed_users) if globalvar.make_welcome_log and welcomed_count > 0: @@ -874,14 +874,14 @@ self.report_bad_account() @staticmethod - def show_status(message=Msg.DEFAULT): + def show_status(message=Msg.DEFAULT) -> None: """Output colorized status.""" msg, color = message.value pywikibot.output(color_format('{color}[{msg:5}]{default} ', msg=msg, color=color), newline=False) - def teardown(self): + def teardown(self) -> None: """Some cleanups after run operation.""" if self.welcomed_users: self.show_status() @@ -930,7 +930,7 @@ 'script source header for documentation.')) -def handle_args(args): +def handle_args(args) -> None: """Process command line arguments. If args is an empty list, sys.argv is used. -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767270 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Ia3ee041a63ad42ac58cb19b22be4cddc1b050be9 Gerrit-Change-Number: 767270 Gerrit-PatchSet: 2 Gerrit-Owner: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [bugfix] import dependecies at top of a script file
by jenkins-bot (Code Review) 01 Mar '22

01 Mar '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767210 ) Change subject: [bugfix] import dependecies at top of a script file ...................................................................... [bugfix] import dependecies at top of a script file Bug: T302774 Change-Id: I939757ea3498927d3df949a478706c472a0a9643 --- M pywikibot/page/__init__.py 1 file changed, 2 insertions(+), 3 deletions(-) Approvals: Matěj Suchánek: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index 536c5cb..f3db6ea 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -30,9 +30,10 @@ from warnings import warn import pywikibot -from pywikibot import config, i18n, textlib +from pywikibot import config, date, i18n, textlib from pywikibot.backports import Dict, Generator, Iterable, List, Tuple from pywikibot.comms import http +from pywikibot.cosmetic_changes import CANCEL, CosmeticChangesToolkit from pywikibot.exceptions import ( APIError, AutoblockUserError, @@ -405,7 +406,6 @@ same names. Regular titles return (None, None). """ if not hasattr(self, '_autoFormat'): - from pywikibot import date self._autoFormat = date.getAutoFormat( self.site.lang, self.title(with_ns=False) @@ -1266,7 +1266,6 @@ pywikibot.log('Cosmetic changes for {}-{} enabled.' .format(family, self.site.lang)) # cc depends on page directly and via several other imports - from pywikibot.cosmetic_changes import CANCEL, CosmeticChangesToolkit cc_toolkit = CosmeticChangesToolkit(self, ignore=CANCEL.MATCH) self.text = cc_toolkit.change(old) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767210 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I939757ea3498927d3df949a478706c472a0a9643 Gerrit-Change-Number: 767210 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [tests] ignore code parts from coverage
by Xqt (Code Review) 01 Mar '22

01 Mar '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767225 ) Change subject: [tests] ignore code parts from coverage ...................................................................... [tests] ignore code parts from coverage - ignore some exceptions - ignore setup.main() which cannot be tested - ignore some pwb.py parts Change-Id: Ic6f310c0b0ef9f9a95935c0154ecf2c38887a88d --- M .coveragerc M pwb.py M setup.py 3 files changed, 21 insertions(+), 16 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/.coveragerc b/.coveragerc index d97beb0..7a11b16 100644 --- a/.coveragerc +++ b/.coveragerc @@ -5,6 +5,10 @@ exclude_lines = # Have to re-enable the standard pragma pragma: no cover + except ImportError + except KeyboardInterrupt + except pkg_resources + except SyntaxError raise NotImplementedError raise unittest\.SkipTest if .PYWIKIBOT_TEST_.*. in os.environ: diff --git a/pwb.py b/pwb.py index fd1ae8a..94b567e 100755 --- a/pwb.py +++ b/pwb.py @@ -73,7 +73,7 @@ scripts_version = Version(getattr(package, '__version__', pwb.__version__)) wikibot_version = Version(pwb.__version__) - if scripts_version.release > wikibot_version.release: + if scripts_version.release > wikibot_version.release: # pragma: no cover print('WARNING: Pywikibot version {} is behind scripts package ' 'version {}.\nYour Pywikibot may need an update or be ' 'misconfigured.\n'.format(wikibot_version, scripts_version)) @@ -84,12 +84,12 @@ .format(wikibot_version.minor - 1, v=wikibot_version)) - if scripts_version.release < prev_wikibot.release: + if scripts_version.release < prev_wikibot.release: # pragma: no cover print('WARNING: Scripts package version {} is behind legacy ' 'Pywikibot version {} and current version {}\nYour scripts ' 'may need an update or be misconfigured.\n' .format(scripts_version, prev_wikibot, wikibot_version)) - elif scripts_version.release < wikibot_version.release: + elif scripts_version.release < wikibot_version.release: # pragma: no cover print('WARNING: Scripts package version {} is behind current version ' '{}\nYour scripts may need an update or be misconfigured.\n' .format(scripts_version, wikibot_version)) @@ -185,7 +185,7 @@ return fname, list(args[index + int(bool(fname)):]), args[:index] -def _print_requirements(requirements, script, variant): +def _print_requirements(requirements, script, variant): # pragma: no cover """Print pip command to install requirements.""" if not requirements: return @@ -227,7 +227,7 @@ from setup import dependencies try: next(pkg_resources.parse_requirements(dependencies)) - except ValueError as e: + except ValueError as e: # pragma: no cover # T286980: setuptools is too old and requirement parsing fails import setuptools setupversion = tuple(int(num) @@ -259,7 +259,7 @@ _print_requirements(missing_requirements, script, 'missing') _print_requirements(version_conflicts, script, 'outdated') - if version_conflicts and not missing_requirements: + if version_conflicts and not missing_requirements: # pragma: no cover print('\nYou may continue on your own risk; type CTRL-C to stop.') try: sleep(5) @@ -279,7 +279,7 @@ os.environ['PYWIKIBOT_DIR_PWB'] = _pwb_dir try: import pywikibot as pwb -except RuntimeError: +except RuntimeError: # pragma: no cover os.environ['PYWIKIBOT_NO_USER_CONFIG'] = '2' import pywikibot as pwb @@ -350,7 +350,7 @@ alternatives, default='1') except QuitKeyboardInterrupt: return None - print() + print() # pragma: no cover return str(scripts[script]) @@ -374,7 +374,7 @@ path_list.append(package) return None - if site_package: + if site_package: # pragma: no cover script_paths = [_pwb_dir] else: script_paths = [ @@ -385,7 +385,7 @@ ] user_script_paths = [] - if config.user_script_paths: + if config.user_script_paths: # pragma: no cover if isinstance(config.user_script_paths, list): user_script_paths = config.user_script_paths else: @@ -394,7 +394,7 @@ .format(type(config.user_script_paths))) found = test_paths(user_script_paths, config.base_dir) - if found: + if found: # pragma: no cover return found found = test_paths(script_paths, _pwb_dir) @@ -414,7 +414,7 @@ if global_args: # don't use sys.argv unknown_args = pwb.handle_args(global_args) - if unknown_args: + if unknown_args: # pragma: no cover print('ERROR: unknown pwb.py argument{}: {}\n' .format('' if len(unknown_args) == 1 else 's', ', '.join(unknown_args))) @@ -471,16 +471,17 @@ previous implementation was renamed to :func:`execute` """ try: - if not check_modules(): + if not check_modules(): # pragma: no cover raise RuntimeError('') # no further output needed - except RuntimeError as e: # setup.py may also raise RuntimeError + # setup.py may also raise RuntimeError + except RuntimeError as e: # pragma: no cover sys.exit(e) if not execute(): print(__doc__) -def run(): +def run(): # pragma: no cover """Site package entry point. Print doc if necessary. .. versionadded:: 7.0 diff --git a/setup.py b/setup.py index 45bf661..76a83e6 100644 --- a/setup.py +++ b/setup.py @@ -243,7 +243,7 @@ return [str(name)] + packages -def main(): +def main(): # pragma: no cover """Setup entry point.""" version = get_validated_version() setup( -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767225 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Ic6f310c0b0ef9f9a95935c0154ecf2c38887a88d Gerrit-Change-Number: 767225 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [tests] Fix pytest-cov dependency for pip 9.0.1
by Xqt (Code Review) 01 Mar '22

01 Mar '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767219 ) Change subject: [tests] Fix pytest-cov dependency for pip 9.0.1 ...................................................................... [tests] Fix pytest-cov dependency for pip 9.0.1 Bug: T302817 Change-Id: I5070a1fc7af7191e79c4b2d6bc7cd59d2f12fab3 --- M dev-requirements.txt 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/dev-requirements.txt b/dev-requirements.txt index bbb5bc7..40f7269 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -4,7 +4,7 @@ pytest >= 5.3 pytest-cov >= 2.11.1, < 3.0.0;python_version<"3.6" pytest-cov >= 3.0.0;python_version>="3.10" -pytest-cov >= 2.11.1 +pytest-cov >= 2.11.1;python_version>="3.6" and python_version<"3.10" pytest-timeout pytest-runner pytest-subtests >= 0.3.2 -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/767219 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I5070a1fc7af7191e79c4b2d6bc7cd59d2f12fab3 Gerrit-Change-Number: 767219 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-CC: jenkins-bot Gerrit-MessageType: merged

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits March 2022