Pywikibot-commits

pywikibot-commits@lists.wikimedia.org

13500 discussions

[Gerrit] ...core[master]: [IMPR] Simplify loop with itertools.pairwise
by jenkins-bot (Code Review) 05 Aug '22

05 Aug '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820689 ) Change subject: [IMPR] Simplify loop with itertools.pairwise ...................................................................... [IMPR] Simplify loop with itertools.pairwise Change-Id: Ifee03724cd8fa194a463b8beda8e809e43696aa7 --- M scripts/archivebot.py 1 file changed, 4 insertions(+), 5 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/archivebot.py b/scripts/archivebot.py index 69fa1d6..6c73eca 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -114,6 +114,7 @@ # Distributed under the terms of the MIT license. # import datetime +import itertools import locale import os import re @@ -393,12 +394,10 @@ cur_thread.feed_line(line) self.threads.append(cur_thread) - if self.keep and len(self.threads) > 1: + if self.keep: # set the timestamp to the previous if the current is lower - prev = self.threads[0].timestamp - for thread in self.threads: - thread.timestamp = self.max(prev, thread.timestamp) - prev = thread.timestamp + for first, second in itertools.pairwise(self.threads): + second.timestamp = self.max(first.timestamp, second.timestamp) # This extra info is not desirable when run under the unittest # framework, which may be run either directly or via setup.py -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820689 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: Ifee03724cd8fa194a463b8beda8e809e43696aa7 Gerrit-Change-Number: 820689 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] detach process_page function from main
by jenkins-bot (Code Review) 05 Aug '22

05 Aug '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820660 ) Change subject: [IMPR] detach process_page function from main ...................................................................... [IMPR] detach process_page function from main Change-Id: I542c06e3b2ab1e10509794a33a7000e75d115d07 --- M scripts/archivebot.py 1 file changed, 32 insertions(+), 19 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/archivebot.py b/scripts/archivebot.py index 305e7fa..69fa1d6 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -787,6 +787,37 @@ self.page.update(comment) +def process_page(pg, tmpl, salt: str, force: bool, keep: bool) -> bool: + """Call PageArchiver for a single page. + + :return: Return True to continue with the next page, False to break + the loop. + + .. versionadded:: 7.6 + """ + if not pg.exists(): + pywikibot.info('{} does not exist, skipping...'.format(pg)) + return True + + pywikibot.info('\n\n>>> <<lightpurple>>{}<<default>> <<<'.format(pg)) + # Catching exceptions, so that errors in one page do not bail out + # the entire process + try: + archiver = PageArchiver(pg, tmpl, salt, force, keep) + archiver.run() + except ArchiveBotSiteConfigError as e: + # no stack trace for errors originated by pages on-site + pywikibot.error('Missing or malformed template in page {}: {}' + .format(pg, e)) + except Exception: + pywikibot.exception('Error occurred while processing page {}' + .format(pg)) + except KeyboardInterrupt: + pywikibot.info('\nUser quit bot run...') + return False + return True + + def main(*args: str) -> None: """ Process command line arguments and invoke bot. @@ -870,25 +901,7 @@ namespaces=ns, content=True) for pg in gen: - if not pg.exists(): - pywikibot.info('{} does not exist, skipping...'.format(pg)) - continue - pywikibot.info('\n\n>>> <<lightpurple>>{}<<default>> <<<' - .format(pg.title())) - # Catching exceptions, so that errors in one page do not bail out - # the entire process - try: - archiver = PageArchiver(pg, tmpl, salt, force, keep) - archiver.run() - except ArchiveBotSiteConfigError as e: - # no stack trace for errors originated by pages on-site - pywikibot.error('Missing or malformed template in page {}: {}' - .format(pg, e)) - except Exception: - pywikibot.exception('Error occurred while processing page {}' - .format(pg)) - except KeyboardInterrupt: - pywikibot.info('\nUser quit bot run...') + if not process_page(pg, tmpl, salt, force, keep): return -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820660 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: I542c06e3b2ab1e10509794a33a7000e75d115d07 Gerrit-Change-Number: 820660 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]: [IMPR] Preserve thread order in archive even if threads are archived ...
by Xqt (Code Review) 05 Aug '22

05 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820469 ) Change subject: [IMPR] Preserve thread order in archive even if threads are archived later ...................................................................... [IMPR] Preserve thread order in archive even if threads are archived later Bug: T314560 Bug: T312773 Change-Id: I8190482d43271e594fa0c4f7a916182ee1117bed --- M scripts/archivebot.py 1 file changed, 41 insertions(+), 6 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/scripts/archivebot.py b/scripts/archivebot.py index d981637..305e7fa 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -101,9 +101,12 @@ -namespace:NS only archive pages from a given namespace -page:PAGE archive a single PAGE, default ns is a user talk page -salt:SALT specify salt + -keep Preserve thread order in archive even if threads are + archived later .. versionchanged:: 7.6 - Localized variables for "archive" template parameter are supported + Localized variables for "archive" template parameter are supported. + `-keep` option was added. """ # # (C) Pywikibot team, 2006-2022 @@ -314,7 +317,7 @@ Feed threads to it and run an update() afterwards. """ - def __init__(self, source, archiver, params=None) -> None: + def __init__(self, source, archiver, params=None, keep=False) -> None: """Initializer.""" super().__init__(source) self.threads = [] @@ -330,6 +333,7 @@ else: self.timestripper = self.archiver.timestripper self.params = params + self.keep = keep try: self.load_page() except NoPageError: @@ -340,8 +344,28 @@ if self.params: self.header = self.header % self.params + @staticmethod + def max( + ts1: Optional[pywikibot.Timestamp], + ts2: Optional[pywikibot.Timestamp] + ) -> Optional[pywikibot.Timestamp]: + """Calculate the maximum of two timestamps but allow None as value. + + .. versionadded:: 7.6 + """ + if ts1 is None: + return ts2 + if ts2 is None: + return ts1 + return max(ts1, ts2) + def load_page(self) -> None: - """Load the page to be archived and break it up into threads.""" + """Load the page to be archived and break it up into threads. + + .. versionchanged:: 7.6 + If `-keep` option is given run through all threads and set + the current timestamp to the previous if the current is lower. + """ self.header = '' self.threads = [] self.archives = {} @@ -369,6 +393,13 @@ cur_thread.feed_line(line) self.threads.append(cur_thread) + if self.keep and len(self.threads) > 1: + # set the timestamp to the previous if the current is lower + prev = self.threads[0].timestamp + for thread in self.threads: + thread.timestamp = self.max(prev, thread.timestamp) + prev = thread.timestamp + # This extra info is not desirable when run under the unittest # framework, which may be run either directly or via setup.py if pywikibot.calledModuleName() not in ['archivebot_tests', 'setup']: @@ -429,7 +460,8 @@ algo = 'none' - def __init__(self, page, template, salt: str, force: bool = False) -> None: + def __init__(self, page, template, salt: str, force: bool = False, + keep=False) -> None: """Initializer. :param page: a page object to be archived @@ -458,7 +490,7 @@ except KeyError: # mw < 1.28 self.maxsize = 2096128 # 2 MB - 1 KB gap - self.page = DiscussionPage(page, self) + self.page = DiscussionPage(page, self, keep=keep) self.comment_params = { 'from': self.page.title(), } @@ -769,6 +801,7 @@ salt = '' force = False calc = None + keep = False templates = [] local_args = pywikibot.handle_args(args) @@ -798,6 +831,8 @@ pagename = value elif option == 'namespace': namespace = value + elif option == 'keep': + keep = True site = pywikibot.Site() @@ -843,7 +878,7 @@ # Catching exceptions, so that errors in one page do not bail out # the entire process try: - archiver = PageArchiver(pg, tmpl, salt, force) + archiver = PageArchiver(pg, tmpl, salt, force, keep) archiver.run() except ArchiveBotSiteConfigError as e: # no stack trace for errors originated by pages on-site -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820469 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: I8190482d43271e594fa0c4f7a916182ee1117bed Gerrit-Change-Number: 820469 Gerrit-PatchSet: 4 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Whym <whym(a)whym.org> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] do not test internal implementation in tests
by jenkins-bot (Code Review) 04 Aug '22

04 Aug '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/817713 ) Change subject: [IMPR] do not test internal implementation in tests ...................................................................... [IMPR] do not test internal implementation in tests Do not test internal implementation of methods, but only external behaviour: - tests.site_tests.TestSiteGenerators.test_unconnected - tests.pagegenerators_tests.TestUnconnectedPageGenerator Change-Id: I16f830eea9c3adc84adeade8ff06fb57efd4d7c8 --- M tests/pagegenerators_tests.py M tests/site_tests.py 2 files changed, 25 insertions(+), 28 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/tests/pagegenerators_tests.py b/tests/pagegenerators_tests.py index 518c364..58df3a2 100755 --- a/tests/pagegenerators_tests.py +++ b/tests/pagegenerators_tests.py @@ -15,7 +15,11 @@ import pywikibot from pywikibot import date, pagegenerators -from pywikibot.exceptions import ServerError, UnknownExtensionError +from pywikibot.exceptions import ( + NoPageError, + ServerError, + UnknownExtensionError, +) from pywikibot.pagegenerators import ( CategorizedPageGenerator, PagesFromTitlesGenerator, @@ -1680,18 +1684,16 @@ """Test UnconnectedPageGenerator.""" if not self.site.data_repository(): self.skipTest('Site is not using a Wikibase repository') - upgen = pagegenerators.UnconnectedPageGenerator(self.site, 3) - self.assertDictEqual( - upgen.request._params, { - 'gqppage': ['UnconnectedPages'], - 'prop': ['info', 'imageinfo', 'categoryinfo'], - 'inprop': ['protection'], - 'iilimit': ['max'], - 'iiprop': ['timestamp', 'user', 'comment', 'url', 'size', - 'sha1', 'metadata'], - 'generator': ['querypage'], 'action': ['query'], - 'indexpageids': [True], 'continue': [True]}) - self.assertLessEqual(len(tuple(upgen)), 3) + pages = list(pagegenerators.UnconnectedPageGenerator(self.site, 3)) + self.assertLessEqual(len(pages), 3) + + site = self.site.data_repository() + pattern = (r'Page ' + r'\[\[({site.sitename}:|{site.code}:)-1\]\]' + r" doesn't exist\.".format(site=site)) + for page in pages: + with self.assertRaisesRegex(NoPageError, pattern): + page.data_item() def test_unconnected_without_repo(self): """Test that it raises a ValueError on sites without repository.""" diff --git a/tests/site_tests.py b/tests/site_tests.py index 4d70509..c3f488e 100755 --- a/tests/site_tests.py +++ b/tests/site_tests.py @@ -896,21 +896,16 @@ """Test site.unconnected_pages method.""" if not self.site.data_repository(): self.skipTest('Site is not using a Wikibase repository') - upgen = self.site.unconnected_pages(total=3) - self.assertEqual( - upgen.request._params, - { - 'gqppage': ['UnconnectedPages'], - 'prop': ['info', 'imageinfo', 'categoryinfo'], - 'inprop': ['protection'], - 'iilimit': ['max'], - 'iiprop': ['timestamp', 'user', 'comment', 'url', 'size', - 'sha1', 'metadata'], - 'generator': ['querypage'], 'action': ['query'], - 'indexpageids': [True], 'continue': [True] - } - ) - self.assertLessEqual(len(tuple(upgen)), 3) + pages = list(self.site.unconnected_pages(total=3)) + self.assertLessEqual(len(pages), 3) + + site = self.site.data_repository() + pattern = (r'Page ' + r'\[\[({site.sitename}:|{site.code}:)-1\]\]' + r" doesn't exist\.".format(site=site)) + for page in pages: + with self.assertRaisesRegex(NoPageError, pattern): + page.data_item() def test_assert_valid_iter_params(self): """Test site.assert_valid_iter_params method.""" -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/817713 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: I16f830eea9c3adc84adeade8ff06fb57efd4d7c8 Gerrit-Change-Number: 817713 Gerrit-PatchSet: 4 Gerrit-Owner: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] Update ROADMAP.rst and CHANGELOG.rst
by Xqt (Code Review) 03 Aug '22

03 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820214 ) Change subject: [doc] Update ROADMAP.rst and CHANGELOG.rst ...................................................................... [doc] Update ROADMAP.rst and CHANGELOG.rst Change-Id: I10ef5eb8097914fbdae865a820f14d7930a74d9e --- M ROADMAP.rst M pywikibot/page/_pages.py M scripts/CHANGELOG.rst 3 files changed, 31 insertions(+), 1 deletion(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/ROADMAP.rst b/ROADMAP.rst index 29b9155..806b446 100644 --- a/ROADMAP.rst +++ b/ROADMAP.rst @@ -1,6 +1,13 @@ Current release 7.6.0 ^^^^^^^^^^^^^^^^^^^^^ +* Fix partial caching in :meth:`Category.subcategories()<page.Category.subcategories>` (:phab:`T88217`) +* Method :meth:`Page.has_content()<page.BasePage.has_content>` was added (:phab:`T313736`) +* Discard cache and reload it if cache was loaded without content and content is required + in :meth:`Page.templates()<page.BasePage.templates>` (:phab:`T313736`) +* Add support for vikidia:oc +* Exit loop in PageFromFileReader if match.end() <= 0 (:phab:`T313684`) +* Allow Exception as parameter of pywikibot.exceptions.Error * Make :func:`GoogleSearchPageGenerator<pagegenerators.GoogleSearchPageGenerator>` and :func:`PetScanPageGenerator<pagegenerators.PetScanPageGenerator>` a restartable Generator (:phab:`T313681`, :phab:`T313683`) diff --git a/pywikibot/page/_pages.py b/pywikibot/page/_pages.py index 51fb874..1ead289 100644 --- a/pywikibot/page/_pages.py +++ b/pywikibot/page/_pages.py @@ -407,6 +407,8 @@ Page has been loaded. Not existing pages are considered loaded. + + .. versionadded:: 7.6 """ return not self.exists() or self._latest_cached_revision() is not None diff --git a/scripts/CHANGELOG.rst b/scripts/CHANGELOG.rst index cac0f1e..9169144 100644 --- a/scripts/CHANGELOG.rst +++ b/scripts/CHANGELOG.rst @@ -6,11 +6,33 @@ *current release* +archivebot +~~~~~~~~~~ + +* Skip the page if it does not exist +* Fix for DiscussionPage.size() (:phab:`T313886`) +* Decrease memory usage and improve processing speed + interwiki ~~~~~~~~~ * Fix wrong Subject property +pagefromfile +~~~~~~~~~~~~ + +* Derive PageFromFileReader from tools.collections.GeneratorWrapper + +7.5.2 +----- + +*26 July 2022* + +archivebot +~~~~~~~~~~ + +* Add localized "archive" variables (:phab:`T71551`, :phab:`T313682`, :phab:`T313692`) + 7.5.1 ----- @@ -21,7 +43,6 @@ * Replace archive pattern fields to string conversion (:phab:`T313692`) - 7.5.0 ----- -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/820214 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: I10ef5eb8097914fbdae865a820f14d7930a74d9e Gerrit-Change-Number: 820214 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]: [IMPR] Make PageFromFileReader an abc.Generator
by jenkins-bot (Code Review) 03 Aug '22

03 Aug '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/816303 ) Change subject: [IMPR] Make PageFromFileReader an abc.Generator ...................................................................... [IMPR] Make PageFromFileReader an abc.Generator - Derive PageFromFileReader from tools.collections.GeneratorWrapper - rename the __iter__ method to the generator property to be reused by the wrapper class Change-Id: I20774c8624670862a59e7881d0af9255cd7afd0b --- M scripts/pagefromfile.py 1 file changed, 18 insertions(+), 12 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/pagefromfile.py b/scripts/pagefromfile.py index f1809c2..05dc9e9 100755 --- a/scripts/pagefromfile.py +++ b/scripts/pagefromfile.py @@ -67,13 +67,13 @@ import codecs import os import re -from typing import Generator import pywikibot from pywikibot import config, i18n -from pywikibot.backports import Tuple +from pywikibot.backports import Tuple, Iterator from pywikibot.bot import CurrentPageBot, OptionHandler, SingleSiteBot from pywikibot.pagegenerators import PreloadingGenerator +from pywikibot.tools.collections import GeneratorWrapper CTX_ATTR = '_content_ctx' @@ -170,9 +170,13 @@ show_diff=self.opt.showdiff) -class PageFromFileReader(OptionHandler): +class PageFromFileReader(OptionHandler, GeneratorWrapper): - """Generator class, responsible for reading the file.""" + """Generator class, responsible for reading the file. + + .. versionchanged:: 7.6 + subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper` + """ # Adapt these to the file you are using. 'begin' and # 'end' are the beginning and end of each entry. Take text that @@ -191,18 +195,18 @@ } def __init__(self, filename, site=None, **kwargs) -> None: - """Initializer. - - Check if self.file name exists. If not, ask for a new filename. - User can quit. - - """ + """Initializer.""" super().__init__(**kwargs) self.filename = filename self.site = site or pywikibot.Site() - def __iter__(self) -> Generator[pywikibot.Page, None, None]: - """Read file and yield a tuple of page title and content.""" + @property + def generator(self) -> Iterator[pywikibot.Page]: + """Read file and yield a tuple of page title and content. + + .. versionchanged:: 7.6 + changed from iterator method to generator property + """ pywikibot.output("\n\nReading '{}'...".format(self.filename)) try: with codecs.open(self.filename, 'r', @@ -301,6 +305,8 @@ options['always'] = 'showdiff' not in options + # Check if self.file name exists. If not, ask for a new filename. + # User can quit. failed_filename = False while not os.path.isfile(filename): pywikibot.output("\nFile '{}' does not exist. ".format(filename)) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/816303 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: I20774c8624670862a59e7881d0af9255cd7afd0b Gerrit-Change-Number: 816303 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] Update references
by Xqt (Code Review) 01 Aug '22

01 Aug '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/819055 ) Change subject: [doc] Update references ...................................................................... [doc] Update references Change-Id: I344a84cab6bc3860812016486b81863814e76197 --- M HISTORY.rst M ROADMAP.rst M docs/api_ref/index.rst M docs/api_ref/pywikibot.rst M docs/faq.rst M docs/library_usage.rst M docs/licenses.rst M pywikibot/bot.py M pywikibot/bot_choice.py M pywikibot/comms/eventstreams.py M pywikibot/data/api/_generators.py M pywikibot/data/memento.py M pywikibot/page/__init__.py M pywikibot/page/_pages.py M pywikibot/pagegenerators/_generators.py M pywikibot/site/_apisite.py M pywikibot/site/_extensions.py M pywikibot/site/_siteinfo.py M pywikibot/userinterfaces/__init__.py M pywikibot/userinterfaces/terminal_interface_base.py M scripts/archivebot.py M scripts/basic.py M scripts/blockpageschecker.py M scripts/category_redirect.py M scripts/change_pagelang.py M scripts/clean_sandbox.py M scripts/commonscat.py M scripts/coordinate_import.py M scripts/delinker.py M scripts/djvutext.py M scripts/download_dump.py M scripts/harvest_template.py M scripts/interwikidata.py M scripts/nowcommons.py M scripts/protect.py M scripts/reflinks.py M scripts/unusedfiles.py M tests/utils.py 38 files changed, 82 insertions(+), 82 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/HISTORY.rst b/HISTORY.rst index 4954881..3f64ec3 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -13,9 +13,9 @@ around wbparsevalue was added (:phab:`T112140`, :phab:`T312755`) * L10N updates * Fix cp encodings in :func:`get_charset_from_content_type() - <pywikibot.comms.http.get_charset_from_content_type>` (:phab:`T312230`) + <comms.http.get_charset_from_content_type>` (:phab:`T312230`) * New :mod:`pywikibot.time` module with new functions in addition to `Timestamp` -* :meth:`Page.revisions()<pywikibot.page.BasePage.revisions>` supports more formats/types for +* :meth:`Page.revisions()<page.BasePage.revisions>` supports more formats/types for starttime and endtime parameters, in addition to those allowed by :meth:`Timestamp.fromISOformat()<pywikibot.Timestamp.fromISOformat>`. * New :meth:`Timestamp.set_timestamp()<pywikibot.Timestamp.set_timestamp>` method @@ -24,7 +24,7 @@ * Handle asynchronous page_put_queue after KeyboardInterrupt in Python 3.9+ (:phab:`T311076`) * No longer expect a specific namespace alias in cosmetic_changes :meth:`translateAndCapitalizeNamespaces - <pywikibot.cosmetic_changes.CosmeticChangesToolkit.translateAndCapitalizeNamespaces>` + <cosmetic_changes.CosmeticChangesToolkit.translateAndCapitalizeNamespaces>` 7.4.0 @@ -32,9 +32,9 @@ *26 June 2022* * Provide Built Distribution with Pywikibot (:pep:`427`) -* Update `WRITE_ACTIONS` in used by :class:`api.Request<pywikibot.data.api.Request>` -* Move :func:`get_closest_memento_url<pywikibot.data.memento.get_closest_memento_url>` from weblinkchecker script to memento module. -* Add :mod:`memento module<pywikibot.data.memento>` to fix memento_client package (:phab:`T185561`) +* Update `WRITE_ACTIONS` in used by :class:`api.Request<data.api.Request>` +* Move :func:`get_closest_memento_url<data.memento.get_closest_memento_url>` from weblinkchecker script to memento module. +* Add :mod:`memento module<data.memento>` to fix memento_client package (:phab:`T185561`) * L10N and i18n updates * Fix Flow board topic continuation when iterating in reverse (:phab:`T138323`) * Add Avestan transliteration @@ -42,7 +42,7 @@ * Show an APIError if PetScanPageGenerator.query() fails (:phab:`T309538`) * `login.py` is now a utiliy script even for site-package installation (:phab:`T309290`) * `preload_sites.py` is now a utiliy script even for site-package installation (:phab:`T308912`) -* :attr:`generator_completed<pywikibot.bot.BaseBot.generator_completed>` became a public attribute +* :attr:`generator_completed<bot.BaseBot.generator_completed>` became a public attribute * Return gracefully from pwb.find_alternates if folder in user_script_paths does not exist (:phab:`T308910`) @@ -176,7 +176,7 @@ * Upload: Retry upload if 'copyuploadbaddomain' API error occurs (:phab:`T294825`) * Update invisible characters from unicodedata 14.0.0 * Add support for Wikimedia OCR engine with proofreadpage -* Rewrite :func:`pywikibot.tools.itertools.intersect_generators` which makes it running up to 10'000 times faster. (:phab:`T85623`, :phab:`T293276`) +* Rewrite :func:`tools.itertools.intersect_generators` which makes it running up to 10'000 times faster. (:phab:`T85623`, :phab:`T293276`) * The cached output functionality from compat release was re-implemented (:phab:`T151727`, :phab:`T73646`, :phab:`T74942`, :phab:`T132135`, :phab:`T144698`, :phab:`T196039`, :phab:`T280466`) * L10N updates * Adjust groupsize within pagegenerators.PreloadingGenerator (:phab:`T291770`) @@ -249,7 +249,7 @@ * pywikibot.__release__ was removed in favour of pywikibot.__version__ * TextfilePageGenerator was replaced by TextIOPageGenerator * PreloadingItemGenerator was replaced by PreloadingEntityGenerator -* DuplicateFilterPageGenerator was replaced by :func:`pywikibot.tools.itertools.filter_unique` +* DuplicateFilterPageGenerator was replaced by :func:`tools.itertools.filter_unique` * ItemPage.concept_url method was replaced by ItemPage.concept_uri * Outdated parameter names has been dropped * Deprecated pywikibot.Error exception were removed in favour of pywikibot.exceptions.Error classes (:phab:`T280227`) @@ -681,7 +681,7 @@ * version.get_module_version() is deprecated and gives no meaningfull result * Fix version.get_module_filename() and update log lines (:phab:`T264235`) * Re-enable printing log header (:phab:`T264235`) -* Fix result of :func:`pywikibot.tools.itertools.intersect_generators` (:phab:`T263947`) +* Fix result of :func:`tools.itertools.intersect_generators` (:phab:`T263947`) * Only show _GLOBAL_HELP options if explicitly wanted * Deprecated Family.version() methods were removed * Unused parameters of page methods like forceReload, insite, throttle, step was removed diff --git a/ROADMAP.rst b/ROADMAP.rst index 0b58951..29b9155 100644 --- a/ROADMAP.rst +++ b/ROADMAP.rst @@ -1,26 +1,26 @@ Current release 7.6.0 ^^^^^^^^^^^^^^^^^^^^^ -* Make :func:`GoogleSearchPageGenerator<pywikibot.pagegenerators.GoogleSearchPageGenerator>` - and :func:`PetScanPageGenerator<pywikibot.pagegenerators.PetScanPageGenerator>` a restartable +* Make :func:`GoogleSearchPageGenerator<pagegenerators.GoogleSearchPageGenerator>` + and :func:`PetScanPageGenerator<pagegenerators.PetScanPageGenerator>` a restartable Generator (:phab:`T313681`, :phab:`T313683`) -* Provide a :class:`collections.GeneratorWrapper<pywikibot.tools.collections.GeneratorWrapper>` +* Provide a :class:`collections.GeneratorWrapper<tools.collections.GeneratorWrapper>` class to start/restart a generator (:phab:`T301318`, :phab:`T312654`, :phab:`T312883`) -* tools' itertools functions were moved to :mod:`pywikibot.tools.itertools` submodule -* tools' collections classes were moved to :mod:`pywikibot.tools.collections` submodule +* tools' itertools functions were moved to :mod:`tools.itertools` submodule +* tools' collections classes were moved to :mod:`tools.collections` submodule * Set successful login status for the OAuth case (:phab:`T313571`) Deprecations ^^^^^^^^^^^^ -* 7.6.0: :mod:`pywikibot.tools.collections` datatypes should no longer imported from :mod:`pywikibot.tools` +* 7.6.0: :mod:`tools.collections` datatypes should no longer imported from :mod:`pywikibot.tools` * 7.5.0: :mod:`pywikibot.textlib`.tzoneFixedOffset class will be removed in favour of :class:`pywikibot.time.TZoneFixedOffset` * 7.4.0: `FilePage.usingPages()` was renamed to :meth:`using_pages()<pywikibot.FilePage.using_pages>` * 7.2.0: ``tb`` parameter of :func:`exception()<pywikibot.exception>` function was renamed to ``exc_info`` * 7.2.0: XMLDumpOldPageGenerator is deprecated in favour of a `content` parameter of `XMLDumpPageGenerator` (:phab:`T306134`) -* 7.2.0: RedirectPageBot and NoRedirectPageBot bot classes are deprecated in favour of :attr:`use_redirects<pywikibot.bot.BaseBot.use_redirects>` attribute -* 7.2.0: :func:`tools.formatter.color_format<pywikibot.tools.formatter.color_format>` is deprecated and will be removed +* 7.2.0: RedirectPageBot and NoRedirectPageBot bot classes are deprecated in favour of :attr:`use_redirects<bot.BaseBot.use_redirects>` attribute +* 7.2.0: :func:`tools.formatter.color_format<tools.formatter.color_format>` is deprecated and will be removed * 7.1.0: Unused `get_redirect` parameter of Page.getOldVersion() will be removed * 7.1.0: APISite._simple_request() will be removed in favour of APISite.simple_request() * 7.0.0: User.isBlocked() method is renamed to is_blocked for consistency @@ -30,8 +30,8 @@ * 7.0.0: Values of APISite.allpages() parameter filterredir other than True, False and None are deprecated * 6.5.0: OutputOption.output() method will be removed in favour of OutputOption.out property * 6.5.0: Infinite rotating file handler with logfilecount of -1 is deprecated -* 6.4.0: 'allow_duplicates' parameter of :func:`pywikibot.tools.itertools.intersect_generators` as positional argument is deprecated, use keyword argument instead -* 6.4.0: 'iterables' of :func:`pywikibot.tools.itertools.intersect_generators` given as a list or tuple is deprecated, either use consecutive iterables or use '*' to unpack +* 6.4.0: 'allow_duplicates' parameter of :func:`tools.itertools.intersect_generators` as positional argument is deprecated, use keyword argument instead +* 6.4.0: 'iterables' of :func:`tools.itertools.intersect_generators` given as a list or tuple is deprecated, either use consecutive iterables or use '*' to unpack * 6.2.0: outputter of OutputProxyOption without out property is deprecated * 6.2.0: ContextOption.output_range() and HighlightContextOption.output_range() are deprecated * 6.2.0: Error messages with '%' style is deprecated in favour for str.format() style diff --git a/docs/api_ref/index.rst b/docs/api_ref/index.rst index f280c72..7196738 100644 --- a/docs/api_ref/index.rst +++ b/docs/api_ref/index.rst @@ -10,7 +10,7 @@ wiki. The :class:`pywikibot.Site` object then calls the MediaWiki API using the -functions provided by :mod:`pywikibot.data.api`. This layer then uses :func:`pywikibot.comms.http.request` +functions provided by :mod:`data.api`. This layer then uses :func:`comms.http.request` to do the actual HTTP request. Contents diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index e0e7617..fc8e54b 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -143,7 +143,7 @@ .. automodule:: throttle -.. :module:: time +.. module:: time :mod:`time` module ------------------ diff --git a/docs/faq.rst b/docs/faq.rst index 91773da..f0530b7 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -5,19 +5,19 @@ can run :py:mod:`preload_sites <pywikibot.scripts.preload_sites>` script to preload site info quickly. 2. If you need the content, use :py:mod:`PreloadingGenerator - <pywikibot.pagegenerators.PreloadingGenerator>` with page generators, - :py:mod:`EntityGenerator <pywikibot.pagegenerators.EntityGenerator>` + <pagegenerators.PreloadingGenerator>` with page generators, + :py:mod:`EntityGenerator <pagegenerators.EntityGenerator>` for wikibase entities and :py:mod:`DequePreloadingGenerator - <pywikibot.pagegenerators.DequePreloadingGenerator>` for a - :py:mod:`DequeGenerator <pywikibot.tools.collections.DequeGenerator>`. + <pagegenerators.DequePreloadingGenerator>` for a + :py:mod:`DequeGenerator <tools.collections.DequeGenerator>`. 3. If you use :py:mod:`GeneratorFactory - <pywikibot.pagegenerators.GeneratorFactory>` with your bot and use its + <pagegenerators.GeneratorFactory>` with your bot and use its :py:mod:`getCombinedGenerator - <pywikibot.pagegenerators.GeneratorFactory.getCombinedGenerator>` method + <pagegenerators.GeneratorFactory.getCombinedGenerator>` method you can set ``preload=True`` to preload page content. This is an alternate to the ``PreloadingGenerator`` function mentioned above. 4. Use :py:mod:`MySQLPageGenerator - <pywikibot.pagegenerators.MySQLPageGenerator >` if direct DB access is + <pagegenerators.MySQLPageGenerator >` if direct DB access is available and appropriate. See also: :manpage:`MySQL` **The bot cannot delete pages** diff --git a/docs/library_usage.rst b/docs/library_usage.rst index 6aae756..c75d413 100644 --- a/docs/library_usage.rst +++ b/docs/library_usage.rst @@ -49,32 +49,32 @@ :1-3: Import necessary framework code parts: :mod:`pywikibot`, :mod:`pywikibot.pagegenerators`, - :class:`pywikibot.bot.ExistingPageBot`. + :class:`bot.ExistingPageBot`. :5: The bot is derived from - :class:`ExistingPageBot<pywikibot.bot.ExistingPageBot>`. + :class:`ExistingPageBot<bot.ExistingPageBot>`. All pages from generator which does not exists are skipped. :7: Every Bot has an *always* option which autoconfirms any changes if set to True. To expand all available options of a bot and set the default values of them, use - :attr:`update_options<pywikibot.bot.BaseBot.update_options>` + :attr:`update_options<bot.BaseBot.update_options>` attribute or update - :attr:`available_options<pywikibot.bot.BaseBot.available_options>` + :attr:`available_options<bot.BaseBot.available_options>` like it is shown in :ref:`BasicBot<Basic script>` below. :12: All changes for each page are made in this - :meth:`treat_page<pywikibot.bot.CurrentPageBot.treat_page>` method. -:14: :attr:`current_page<pywikibot.bot.BaseBot.current_page>` is the current + :meth:`treat_page<bot.CurrentPageBot.treat_page>` method. +:14: :attr:`current_page<bot.BaseBot.current_page>` is the current :class:`pywikibot.Page` object from - :attr:`generator<pywikibot.bot.BaseBot.generator>`. + :attr:`generator<bot.BaseBot.generator>`. :15: All bot options which are passed to the bot class when instantiating it are accessable via - :class:`opt attribute<pywikibot.bot.OptionHandler>`. ``opt.always``, + :class:`opt attribute<bot.OptionHandler>`. ``opt.always``, ``opt.text`` and ``opt.summary`` are all available options for this bot class. :16: Save the changes to the live wiki with - :meth:`put_current<pywikibot.bot.CurrentPageBot.put_current>`. + :meth:`put_current<bot.CurrentPageBot.put_current>`. :18: Parse command line options inside this function. :20: A dict which holds all options for the bot. -:21: :py:obj:`pywikibot.pagegenerators.GeneratorFactory` supports +:21: :py:obj:`pagegenerators.GeneratorFactory` supports generators and filter options. :23: Pywikibot provides :ref:`global options<Global Options>` like site specification or a *simulate* switch to prevent live wiki changes. @@ -83,7 +83,7 @@ :ref:`filter options<Filter Options>` of :mod:`pywikibot.pagegenerators` are parsed here using :meth:`GeneratorFactory.handle_args() - <pywikibot.pagegenerators.GeneratorFactory.handle_args>`. + <pagegenerators.GeneratorFactory.handle_args>`. :25: Local options which are are available for the current bot are parsed in this loop. :29: Create the bot passing keyword only parameters and run it. diff --git a/docs/licenses.rst b/docs/licenses.rst index f07112a..86c44e8 100644 --- a/docs/licenses.rst +++ b/docs/licenses.rst @@ -7,7 +7,7 @@ :ref:`MIT license`; translations by translators and manual pages on mediawiki.org are available under the `CC-BY-SA 3.0`_ license. The Pywikibot logo is Public domain but it includes material that may be -protected as a trademark. Parts of :mod:`memento<pywikibot.data.memento>` +protected as a trademark. Parts of :mod:`memento<data.memento>` module is licenced under the `BSD`_ open source software license. You may obtain a copy of the License at http://mementoweb.github.io/SiteStory/license.html. diff --git a/pywikibot/bot.py b/pywikibot/bot.py index 97948ea..9720398 100644 --- a/pywikibot/bot.py +++ b/pywikibot/bot.py @@ -1219,7 +1219,7 @@ implemented by subclasses. Each item processed by :meth:`treat` must be a - :class:`pywikibot.page.BasePage` type. Use :meth:`init_page` to + :class:`page.BasePage` type. Use :meth:`init_page` to upcast the type. To enable other types, set :attr:`BaseBot.treat_page_type` to an appropriate type; your bot should derive from :class:`BaseBot` in that case and handle site @@ -1606,7 +1606,7 @@ """Process one page (abstract method). :param page: Object to be processed, usually a - :class:`pywikibot.page.BasePage`. For other page types the + :class:`page.BasePage`. For other page types the :attr:`treat_page_type` must be set. """ raise NotImplementedError('Method {}.treat() not implemented.' @@ -1953,7 +1953,7 @@ A class which automatically defines ``summary`` for ``put_current``. The class must defined a ``summary_key`` string which contains the - i18n key for :py:obj:`pywikibot.i18n.twtranslate`. It can also + i18n key for :py:obj:`i18n.twtranslate`. It can also override the ``summary_parameters`` property to specify any parameters for the translated message. """ diff --git a/pywikibot/bot_choice.py b/pywikibot/bot_choice.py index 6e13acf..2dbbdc8 100644 --- a/pywikibot/bot_choice.py +++ b/pywikibot/bot_choice.py @@ -105,7 +105,7 @@ .. note:: OutputOption must have an :py:obj:`out` property which returns a string for :py:meth:`userinterface output() - <pywikibot.userinterfaces._interface_base.ABUIC.output>` + <userinterfaces._interface_base.ABUIC.output>` method. """ @@ -126,7 +126,7 @@ """String to be used when selected before or after the question. .. note:: This method is used by :meth:`ui.input_choice - <pywikibot.userinterfaces._interface_base.ABUIC.input_choice>` + <userinterfaces._interface_base.ABUIC.input_choice>` instead of deprecated :meth:`output`. .. versionadded:: 6.2 diff --git a/pywikibot/comms/eventstreams.py b/pywikibot/comms/eventstreams.py index eed7350..21f591b 100644 --- a/pywikibot/comms/eventstreams.py +++ b/pywikibot/comms/eventstreams.py @@ -106,7 +106,7 @@ >>> del stream .. versionchanged:: 7.6 - subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper` + subclassed from :class:`tools.collections.GeneratorWrapper` """ def __init__(self, **kwargs) -> None: diff --git a/pywikibot/data/api/_generators.py b/pywikibot/data/api/_generators.py index 312cd13..f4802f0 100644 --- a/pywikibot/data/api/_generators.py +++ b/pywikibot/data/api/_generators.py @@ -3,7 +3,7 @@ .. versionchanged:: 7.6 All Objects were changed from Iterable object to a Generator object. They are subclassed from - :class:`pywikibot.tools.collections.GeneratorWrapper` + :class:`tools.collections.GeneratorWrapper` """ # # (C) Pywikibot team, 2008-2022 @@ -73,7 +73,7 @@ after iterating that many values. .. versionchanged:: 7.6 - subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper` + subclassed from :class:`tools.collections.GeneratorWrapper` """ def __init__( @@ -199,7 +199,7 @@ options. .. versionchanged:: 7.6 - subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper` + subclassed from :class:`tools.collections.GeneratorWrapper` """ # Should results be filtered during iteration according to set_namespace? diff --git a/pywikibot/data/memento.py b/pywikibot/data/memento.py index f295356..55d3cfc 100644 --- a/pywikibot/data/memento.py +++ b/pywikibot/data/memento.py @@ -45,7 +45,7 @@ >>> mc = MementoClient() >>> dt = mc.convert_to_datetime("Sun, 01 Apr 2010 12:00:00 GMT") - >>> mi = mc.get_memento_info("http://www.bbc.com/", dt, timeout=40) + >>> mi = mc.get_memento_info("http://www.bbc.com/", dt, timeout=60) >>> mi['original_uri'] 'http://www.bbc.com/' >>> mi['timegate_uri'] diff --git a/pywikibot/page/__init__.py b/pywikibot/page/__init__.py index 7434b8f..502e923 100644 --- a/pywikibot/page/__init__.py +++ b/pywikibot/page/__init__.py @@ -67,7 +67,7 @@ Uses the first encoding that doesn't cause an error. .. deprecated:: 6.2 - Use :func:`pywikibot.tools.chars.url2string` instead. + Use :func:`tools.chars.url2string` instead. :param title: URL-encoded character data to convert :param encodings: Encodings to attempt to use during conversion. diff --git a/pywikibot/page/_pages.py b/pywikibot/page/_pages.py index b5ebb4a..51fb874 100644 --- a/pywikibot/page/_pages.py +++ b/pywikibot/page/_pages.py @@ -2164,7 +2164,7 @@ """Extract templates and parameters. This method is using - :func:`pywikibot.textlib.extract_templates_and_params`. + :func:`textlib.extract_templates_and_params`. Disabled parts and whitespace are stripped, except for whitespace in anonymous positional arguments. diff --git a/pywikibot/pagegenerators/_generators.py b/pywikibot/pagegenerators/_generators.py index 5a92a8c..9ea56df 100644 --- a/pywikibot/pagegenerators/_generators.py +++ b/pywikibot/pagegenerators/_generators.py @@ -305,7 +305,7 @@ ) -> Iterable['pywikibot.page.Page']: """Yield all pages linked from a specific page. - See :py:obj:`pywikibot.page.BasePage.linkedPages` for details. + See :py:obj:`page.BasePage.linkedPages` for details. :param linkingPage: the page that links to the pages we want :param total: the total number of pages to iterate @@ -795,7 +795,7 @@ generator prints a warning for each query. .. versionchanged:: 7.6 - subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper` + subclassed from :class:`tools.collections.GeneratorWrapper` """ def __init__(self, query: Optional[str] = None, @@ -1106,7 +1106,7 @@ .. seealso:: https://petscan.wmflabs.org/ .. versionadded:: 3.0 .. versionchanged:: 7.6 - subclassed from :class:`pywikibot.tools.collections.GeneratorWrapper` + subclassed from :class:`tools.collections.GeneratorWrapper` """ def __init__(self, categories: Sequence[str], diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 8a6332f..de85f4a 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -1549,7 +1549,7 @@ .. seealso:: - :api:`Parse` - - :meth:`pywikibot.page.BasePage.get_parsed_page`. + - :meth:`page.BasePage.get_parsed_page`. """ req = self.simple_request(action='parse', page=page) data = req.submit() diff --git a/pywikibot/site/_extensions.py b/pywikibot/site/_extensions.py index 220db27..cafa212 100644 --- a/pywikibot/site/_extensions.py +++ b/pywikibot/site/_extensions.py @@ -746,7 +746,7 @@ - https://www.mediawiki.org/wiki/Extension:TextExtracts - - :meth:`pywikibot.page.BasePage.extract`. + - :meth:`page.BasePage.extract`. """ if not page.exists(): raise NoPageError(page) diff --git a/pywikibot/site/_siteinfo.py b/pywikibot/site/_siteinfo.py index 5b00854..b973adc 100644 --- a/pywikibot/site/_siteinfo.py +++ b/pywikibot/site/_siteinfo.py @@ -77,11 +77,11 @@ - 'semiprotectedlevels': 'autoconfirmed' - 'levels': '' (everybody), 'autoconfirmed', 'sysop' - 'types': 'create', 'edit', 'move', 'upload' - Otherwise it returns :py:obj:`pywikibot.tools.EMPTY_DEFAULT`. + Otherwise it returns :py:obj:`tools.EMPTY_DEFAULT`. :param key: The property name :return: The default value - :rtype: dict or :py:obj:`pywikibot.tools.EmptyDefault` + :rtype: dict or :py:obj:`tools.EmptyDefault` """ if key == 'restrictions': # implemented in b73b5883d486db0e9278ef16733551f28d9e096d diff --git a/pywikibot/userinterfaces/__init__.py b/pywikibot/userinterfaces/__init__.py index fa9afbd..5c20a19 100644 --- a/pywikibot/userinterfaces/__init__.py +++ b/pywikibot/userinterfaces/__init__.py @@ -4,7 +4,7 @@ which takes the root logger as its only argument, and which adds to that logger whatever handlers and formatters are needed to process output and display it to the user. The default -(:mod:`terminal<pywikibot.userinterfaces.terminal_interface_base>`) +(:mod:`terminal<userinterfaces.terminal_interface_base>`) interface sends level :const:`STDOUT` to `sys.stdout` (as all interfaces should) and sends all other levels to `sys.stderr`; levels :const:`WARNING` and above are labeled with the level name. @@ -12,5 +12,5 @@ UserInterface objects must also define methods `input()`, `input_choice()`, `input_list_choice()`, `output()` and `editText()`, all of which are documented in the abstract class -:class:`pywikibot.userinterfaces._interface_base.ABUIC`. +:class:`userinterfaces._interface_base.ABUIC`. """ diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py index d160084..91f3c11 100644 --- a/pywikibot/userinterfaces/terminal_interface_base.py +++ b/pywikibot/userinterfaces/terminal_interface_base.py @@ -61,7 +61,7 @@ .. versionchanged:: 6.2: subclassed from - :py:obj:`pywikibot.userinterfaces._interface_base.ABUIC` + :py:obj:`userinterfaces._interface_base.ABUIC` """ split_col_pat = re.compile(r'(\w+);?(\w+)?') diff --git a/scripts/archivebot.py b/scripts/archivebot.py index 33394aa..d981637 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -68,7 +68,7 @@ Alternatively you may use localized digits. This is only available for a few site languages. Refer :attr:`NON_LATIN_DIGITS -<pywikibot.userinterfaces.transliteration.NON_LATIN_DIGITS>` whether +<userinterfaces.transliteration.NON_LATIN_DIGITS>` whether there is a localized one: %(localcounter)s the current value of the counter diff --git a/scripts/basic.py b/scripts/basic.py index 30d5433..451bb31 100755 --- a/scripts/basic.py +++ b/scripts/basic.py @@ -23,7 +23,7 @@ -summary: Set the action summary message for the edit. This sample script is a -:py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All settings can be +:py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All settings can be made either by giving option with the command line or with a settings file which is scripts.ini by default. If you don't want the default values you can add any option you want to change to that settings file below the [basic] diff --git a/scripts/blockpageschecker.py b/scripts/blockpageschecker.py index cd677e8..60e7419 100755 --- a/scripts/blockpageschecker.py +++ b/scripts/blockpageschecker.py @@ -19,7 +19,7 @@ -moveprotected Same as -protectedpages, for moveprotected pages -This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. +This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. The following options can be set within a settings file which is scripts.ini by default:: diff --git a/scripts/category_redirect.py b/scripts/category_redirect.py index d0ce5b7..7af3042 100755 --- a/scripts/category_redirect.py +++ b/scripts/category_redirect.py @@ -26,7 +26,7 @@ python pwb.py category_redirect [options] .. note:: This script is a - :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options + :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options can be set within a settings file which is scripts.ini by default. """ # diff --git a/scripts/change_pagelang.py b/scripts/change_pagelang.py index a8aec48..7946203 100755 --- a/scripts/change_pagelang.py +++ b/scripts/change_pagelang.py @@ -17,7 +17,7 @@ the one set in -setlang (keep the current language). .. note:: This script is a - :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options + :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options can be set within a settings file which is scripts.ini by default. """ # diff --git a/scripts/clean_sandbox.py b/scripts/clean_sandbox.py index a6b199a..c8f59ce 100755 --- a/scripts/clean_sandbox.py +++ b/scripts/clean_sandbox.py @@ -23,7 +23,7 @@ -summary Summary of the edit made by bot. Overrides the default from i18n. -This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. +This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All local parameters can be given inside a scripts.ini file. Options passed to the script are priorized over options read from ini file. diff --git a/scripts/commonscat.py b/scripts/commonscat.py index ad8392f..2145865 100755 --- a/scripts/commonscat.py +++ b/scripts/commonscat.py @@ -12,7 +12,7 @@ -checkcurrent Work on all category pages that use the primary commonscat template. -This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. +This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. The following options can be set within a settings file which is scripts.ini by default:: diff --git a/scripts/coordinate_import.py b/scripts/coordinate_import.py index 08f843e..4e6b77d 100755 --- a/scripts/coordinate_import.py +++ b/scripts/coordinate_import.py @@ -37,7 +37,7 @@ -create Create items for pages without one. .. note:: This script is a - :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options + :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options can be set within a settings file which is scripts.ini by default. &params; diff --git a/scripts/delinker.py b/scripts/delinker.py index 507e56e..872f144 100644 --- a/scripts/delinker.py +++ b/scripts/delinker.py @@ -20,7 +20,7 @@ the next script call starts there if no `-since` is given. .. note:: This sample script is a - :class:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All + :class:`ConfigParserBot <bot.ConfigParserBot>`. All settings can be made either by giving option with the command line or with a settings file which is scripts.ini by default. If you don't want the default values you can add any option you want to change to diff --git a/scripts/djvutext.py b/scripts/djvutext.py index 8e3ca18..4c85336 100755 --- a/scripts/djvutext.py +++ b/scripts/djvutext.py @@ -20,7 +20,7 @@ A -> just page A -B -> pages 1 until B -This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. +This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. The following options can be set within a settings file which is scripts.ini by default: diff --git a/scripts/download_dump.py b/scripts/download_dump.py index abe740c..009a62f 100755 --- a/scripts/download_dump.py +++ b/scripts/download_dump.py @@ -12,7 +12,7 @@ formatted as YYYYMMDD. .. note:: This script is a - :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options + :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options can be set within a settings file which is scripts.ini by default. """ # diff --git a/scripts/harvest_template.py b/scripts/harvest_template.py index 48f6dc9..b85f714 100755 --- a/scripts/harvest_template.py +++ b/scripts/harvest_template.py @@ -91,7 +91,7 @@ -multi .. note:: This script is a - :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options + :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options can be set within a settings file which is scripts.ini by default. .. versionadded:: 7.5 the -inverse option. diff --git a/scripts/interwikidata.py b/scripts/interwikidata.py index fc068b4..dfeebf1 100755 --- a/scripts/interwikidata.py +++ b/scripts/interwikidata.py @@ -25,7 +25,7 @@ -summary: Use your own edit summary for cleaning the page. .. note:: This script is a - :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options + :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options can be set within a settings file which is scripts.ini by default. """ diff --git a/scripts/nowcommons.py b/scripts/nowcommons.py index a395ad5..90b9154 100755 --- a/scripts/nowcommons.py +++ b/scripts/nowcommons.py @@ -39,7 +39,7 @@ python pwb.py nowcommons -replaceonly -replaceloose -replacealways -replace .. note:: This script is a - :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. All options + :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. All options can be set within a settings file which is scripts.ini by default. """ # diff --git a/scripts/protect.py b/scripts/protect.py index a2f13d4..23f995a 100755 --- a/scripts/protect.py +++ b/scripts/protect.py @@ -24,7 +24,7 @@ parameters -unprotect or -default are used, only the last occurrence is applied. -This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. +This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. The following options can be set within a settings file which is scripts.ini by default:: diff --git a/scripts/reflinks.py b/scripts/reflinks.py index 377b456..51c0951 100755 --- a/scripts/reflinks.py +++ b/scripts/reflinks.py @@ -23,7 +23,7 @@ -xmlstart Page to start with when using an XML dump -This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. +This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. The following options can be set within a settings file which is scripts.ini by default:: diff --git a/scripts/unusedfiles.py b/scripts/unusedfiles.py index 4512329..c1a7584 100755 --- a/scripts/unusedfiles.py +++ b/scripts/unusedfiles.py @@ -9,7 +9,7 @@ If not used, all pages are used. -always Don't be asked every time. -This script is a :py:obj:`ConfigParserBot <pywikibot.bot.ConfigParserBot>`. +This script is a :py:obj:`ConfigParserBot <bot.ConfigParserBot>`. The following options can be set within a settings file which is scripts.ini by default:: diff --git a/tests/utils.py b/tests/utils.py index cd32dbe..805ea62 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -209,7 +209,7 @@ class DryParamInfo(dict): - """Dummy class to use instead of :py:obj:`pywikibot.data.api.ParamInfo`.""" + """Dummy class to use instead of :py:obj:`data.api.ParamInfo`.""" def __init__(self, *args, **kwargs): """Initializer.""" @@ -284,7 +284,7 @@ class DryRequest(CachedRequest): - """Dummy class to use instead of :py:obj:`pywikibot.data.api.Request`.""" + """Dummy class to use instead of :py:obj:`data.api.Request`.""" def __init__(self, *args, **kwargs): """Initializer.""" -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/819055 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: I344a84cab6bc3860812016486b81863814e76197 Gerrit-Change-Number: 819055 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...i18n[master]: Localisation updates from https://translatewiki.net.
by jenkins-bot (Code Review) 01 Aug '22

01 Aug '22

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/i18n/+/819027 ) Change subject: Localisation updates from https://translatewiki.net. ...................................................................... Localisation updates from https://translatewiki.net. Change-Id: I0b15581d8d35c84df92df4822733979d57b98d3c --- A add_text/sms.json A category/sms.json 2 files changed, 16 insertions(+), 0 deletions(-) Approvals: L10n-bot: Looks good to me, approved jenkins-bot: Verified diff --git a/add_text/sms.json b/add_text/sms.json new file mode 100644 index 0000000..c6a6f2e --- /dev/null +++ b/add_text/sms.json @@ -0,0 +1,8 @@ +{ + "@metadata": { + "authors": [ + "Yupik" + ] + }, + "add_text-adding": "Bott lââʹzzti %(adding)s" +} diff --git a/category/sms.json b/category/sms.json new file mode 100644 index 0000000..24c772f --- /dev/null +++ b/category/sms.json @@ -0,0 +1,8 @@ +{ + "@metadata": { + "authors": [ + "Yupik" + ] + }, + "category-adding": "Bott lââʹzzti kategoria [[:Category:%(newcat)s|%(newcat)s]]" +} -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/i18n/+/819027 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/i18n Gerrit-Branch: master Gerrit-Change-Id: I0b15581d8d35c84df92df4822733979d57b98d3c Gerrit-Change-Number: 819027 Gerrit-PatchSet: 1 Gerrit-Owner: L10n-bot <l10n-bot(a)translatewiki.net> Gerrit-Reviewer: L10n-bot <l10n-bot(a)translatewiki.net> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] Expand module index for logging, scripts, site and time module
by Xqt (Code Review) 31 Jul '22

31 Jul '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818616 ) Change subject: [doc] Expand module index for logging, scripts, site and time module ...................................................................... [doc] Expand module index for logging, scripts, site and time module Bug: T308063 Change-Id: Id3f1c5e0b5d799e3afce1cff37e4d95fa2fb7d1d --- M docs/api_ref/pywikibot.rst M docs/api_ref/pywikibot.site.rst M docs/conf.py 3 files changed, 29 insertions(+), 1 deletion(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index a12c651..e0e7617 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -1,7 +1,7 @@ pywikibot package ================= -#.. automodule:: pywikibot +.. automodule:: pywikibot Pywikibot Subpackages --------------------- @@ -104,11 +104,14 @@ .. automodule:: logentries +.. module:: logging + :mod:`logging` module --------------------- .. automodule:: pywikibot.logging :member-order: bysource + :noindex: :mod:`login` module ------------------- @@ -140,10 +143,13 @@ .. automodule:: throttle +.. :module:: time + :mod:`time` module ------------------ .. automodule:: pywikibot.time + :noindex: :mod:`titletranslate` module ---------------------------- diff --git a/docs/api_ref/pywikibot.site.rst b/docs/api_ref/pywikibot.site.rst index 9c0abe3..8fe9b46 100644 --- a/docs/api_ref/pywikibot.site.rst +++ b/docs/api_ref/pywikibot.site.rst @@ -1,49 +1,70 @@ :mod:`site` package =================== +.. py:module:: site .. automodule:: pywikibot.site :no-members: + :noindex: :mod:`BaseSite<pywikibot.site._basesite>` package ------------------------------------------------- +.. py:module:: site._basesite .. automodule:: pywikibot.site._basesite + :noindex: + +.. py:module:: site._apisite :mod:`APISite<pywikibot.site.\_apisite>` Package ------------------------------------------------ .. automodule:: pywikibot.site._apisite + :noindex: .. automodule:: pywikibot.site._extensions + :noindex: .. automodule:: pywikibot.site._generators + :noindex: :mod:`DataSite<pywikibot.site.\_datasite>` Package -------------------------------------------------- +.. py:module:: site._datasite .. automodule:: pywikibot.site._datasite + :noindex: :mod:`Obsolete Sites<pywikibot.site._obsoletesites>` Package ------------------------------------------------------------ +.. py:module:: site._obsoletesites .. automodule:: pywikibot.site._obsoletesites + :noindex: :mod:`Siteinfo<pywikibot.site._siteinfo>` Package ------------------------------------------------- +.. py:module:: site._siteinfo .. automodule:: pywikibot.site._siteinfo + :noindex: :mod:`Namespace<pywikibot.site._namespace>` Package --------------------------------------------------- +.. py:module:: site._namespace .. automodule:: pywikibot.site._namespace + :noindex: :mod:`TokenWallet<pywikibot.site._tokenwallet>` Package ------------------------------------------------------- +.. py:module:: site._tokenwallet .. automodule:: pywikibot.site._tokenwallet + :noindex: :mod:`Uploader<pywikibot.site._upload>` Package ----------------------------------------------- +.. py:module:: site._upload .. automodule:: pywikibot.site._upload + :noindex: diff --git a/docs/conf.py b/docs/conf.py index a6b12ea..7a3375a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -371,6 +371,7 @@ # Allow lines like "Example:" to be followed by a code block napoleon_use_admonition_for_examples = True python_use_unqualified_type_names = True +modindex_common_prefix = ['pywikibot.scripts.'] # Pywikibot theme style html_permalinks_icon = '#' -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818616 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: Id3f1c5e0b5d799e3afce1cff37e4d95fa2fb7d1d Gerrit-Change-Number: 818616 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [doc] Expand module index
by Xqt (Code Review) 31 Jul '22

31 Jul '22

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818612 ) Change subject: [doc] Expand module index ...................................................................... [doc] Expand module index Add all pywikibot modules to modules index. Unfortunately this does not work for logging, site, and time module because this conflicts with Python library. Maybe pywikibot.scripts should be renamed to be unique from (bot) scripts module. Bug: T308063 Change-Id: Ice63e6754aed80dfd6d5fcb3bfe17137c0954e28 --- M docs/api_ref/pywikibot.comms.rst M docs/api_ref/pywikibot.config.rst M docs/api_ref/pywikibot.data.rst M docs/api_ref/pywikibot.families.rst M docs/api_ref/pywikibot.page.rst M docs/api_ref/pywikibot.pagegenerators.rst M docs/api_ref/pywikibot.rst M docs/api_ref/pywikibot.site.rst M docs/api_ref/pywikibot.specialbots.rst M docs/api_ref/pywikibot.tools.rst M docs/api_ref/pywikibot.userinterfaces.rst M docs/conf.py 12 files changed, 354 insertions(+), 352 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/docs/api_ref/pywikibot.comms.rst b/docs/api_ref/pywikibot.comms.rst index abe9441..0198120 100644 --- a/docs/api_ref/pywikibot.comms.rst +++ b/docs/api_ref/pywikibot.comms.rst @@ -1,19 +1,19 @@ -pywikibot.comms package -======================= +:mod:`comms` package +==================== -.. automodule:: pywikibot.comms +.. automodule:: comms Submodules ---------- -pywikibot.comms.eventstreams module ------------------------------------ +:mod:`comms.eventstreams` module +-------------------------------- -.. automodule:: pywikibot.comms.eventstreams +.. automodule:: comms.eventstreams -pywikibot.comms.http module ---------------------------- +:mod:`comms.http` module +------------------------ -.. automodule:: pywikibot.comms.http +.. automodule:: comms.http diff --git a/docs/api_ref/pywikibot.config.rst b/docs/api_ref/pywikibot.config.rst index a4fe0fb..68c6f02 100644 --- a/docs/api_ref/pywikibot.config.rst +++ b/docs/api_ref/pywikibot.config.rst @@ -1,10 +1,10 @@ -pywikibot.config module ------------------------ +:mod:`config` module +-------------------- API reference ^^^^^^^^^^^^^ -.. automodule:: pywikibot.config +.. automodule:: config Option setting ^^^^^^^^^^^^^^ diff --git a/docs/api_ref/pywikibot.data.rst b/docs/api_ref/pywikibot.data.rst index 12b7d14..16d02fa 100644 --- a/docs/api_ref/pywikibot.data.rst +++ b/docs/api_ref/pywikibot.data.rst @@ -1,34 +1,34 @@ -pywikibot.data package -====================== +:mod:`data` package +=================== -.. automodule:: pywikibot.data +.. automodule:: data Submodules ---------- -pywikibot.data.api module +:mod:`data.api` module +---------------------- + +.. automodule:: data.api + +:mod:`data.memento` module +-------------------------- + +.. automodule:: data.memento + +:mod:`data.mysql` module +------------------------ + +.. automodule:: data.mysql + +:mod:`data.sparql` module ------------------------- -.. automodule:: pywikibot.data.api +.. automodule:: data.sparql -pywikibot.data.memento module ------------------------------ - -.. automodule:: pywikibot.data.memento - -pywikibot.data.mysql module ---------------------------- - -.. automodule:: pywikibot.data.mysql - -pywikibot.data.sparql module +:mod:`data.wikistats` module ---------------------------- -.. automodule:: pywikibot.data.sparql - -pywikibot.data.wikistats module -------------------------------- - -.. automodule:: pywikibot.data.wikistats +.. automodule:: data.wikistats diff --git a/docs/api_ref/pywikibot.families.rst b/docs/api_ref/pywikibot.families.rst index bde8a39..ce5f8f0 100644 --- a/docs/api_ref/pywikibot.families.rst +++ b/docs/api_ref/pywikibot.families.rst @@ -1,143 +1,142 @@ -pywikibot.families package -========================== +:mod:`families` package +======================= -.. automodule:: pywikibot.families +.. automodule:: families Submodules ---------- -pywikibot.families.commons\_family module ------------------------------------------ - -.. automodule:: pywikibot.families.commons_family - -pywikibot.families.foundation\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.foundation_family - -pywikibot.families.i18n\_family module +:mod:`families.commons\_family` module -------------------------------------- -.. automodule:: pywikibot.families.i18n_family +.. automodule:: families.commons_family -pywikibot.families.incubator\_family module -------------------------------------------- +:mod:`families.foundation\_family` module +----------------------------------------- -.. automodule:: pywikibot.families.incubator_family +.. automodule:: families.foundation_family -pywikibot.families.lingualibre\_family module ---------------------------------------------- +:mod:`families.i18n\_family` module +----------------------------------- -.. automodule:: pywikibot.families.lingualibre_family +.. automodule:: families.i18n_family -pywikibot.families.mediawiki\_family module -------------------------------------------- +:mod:`families.incubator\_family` module +---------------------------------------- -.. automodule:: pywikibot.families.mediawiki_family +.. automodule:: families.incubator_family -pywikibot.families.meta\_family module +:mod:`families.lingualibre\_family` module +------------------------------------------ + +.. automodule:: families.lingualibre_family + +:mod:`families.mediawiki\_family` module +---------------------------------------- + +.. automodule:: families.mediawiki_family + +:mod:`families.meta\_family` module +----------------------------------- + +.. automodule:: families.meta_family + +:mod:`families.omegawiki\_family` module +---------------------------------------- + +.. automodule:: families.omegawiki_family + +:mod:`families.osm\_family` module +---------------------------------- + +.. automodule:: families.osm_family + +:mod:`families.outreach\_family` module +--------------------------------------- + +.. automodule:: families.outreach_family + +:mod:`families.species\_family` module -------------------------------------- -.. automodule:: pywikibot.families.meta_family +.. automodule:: families.species_family -pywikibot.families.omegawiki\_family module -------------------------------------------- +:mod:`families.vikidia\_family` module +-------------------------------------- -.. automodule:: pywikibot.families.omegawiki_family +.. automodule:: families.vikidia_family -pywikibot.families.osm\_family module -------------------------------------- +:mod:`families.wikibooks\_family` module +---------------------------------------- -.. automodule:: pywikibot.families.osm_family +.. automodule:: families.wikibooks_family -pywikibot.families.outreach\_family module ------------------------------------------- +:mod:`families.wikidata\_family` module +--------------------------------------- -.. automodule:: pywikibot.families.outreach_family +.. automodule:: families.wikidata_family -pywikibot.families.species\_family module +:mod:`families.wikihow\_family` module +-------------------------------------- + +.. automodule:: families.wikihow_family + +:mod:`families.wikimania\_family` module +---------------------------------------- + +.. automodule:: families.wikimania_family + +:mod:`families.wikimediachapter\_family` module +----------------------------------------------- + +.. automodule:: families.wikimediachapter_family + +:mod:`families.wikinews\_family` module +--------------------------------------- + +.. automodule:: families.wikinews_family + +:mod:`families.wikipedia\_family` module +---------------------------------------- + +.. automodule:: families.wikipedia_family + +:mod:`families.wikiquote\_family` module +---------------------------------------- + +.. automodule:: families.wikiquote_family + +:mod:`families.wikisource\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.species_family +.. automodule:: families.wikisource_family -pywikibot.families.vikidia\_family module +:mod:`families.wikisopore\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.vikidia_family +.. automodule:: families.wikispore_family -pywikibot.families.wikibooks\_family module -------------------------------------------- +:mod:`families.wikitech\_family` module +--------------------------------------- -.. automodule:: pywikibot.families.wikibooks_family +.. automodule:: families.wikitech_family -pywikibot.families.wikidata\_family module +:mod:`families.wikiversity\_family` module ------------------------------------------ -.. automodule:: pywikibot.families.wikidata_family +.. automodule:: families.wikiversity_family -pywikibot.families.wikihow\_family module +:mod:`families.wikivoyage\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.wikihow_family +.. automodule:: families.wikivoyage_family -pywikibot.families.wikimania\_family module -------------------------------------------- - -.. automodule:: pywikibot.families.wikimania_family - -pywikibot.families.wikimediachapter\_family module --------------------------------------------------- - -.. automodule:: pywikibot.families.wikimediachapter_family - -pywikibot.families.wikinews\_family module ------------------------------------------- - -.. automodule:: pywikibot.families.wikinews_family - -pywikibot.families.wikipedia\_family module -------------------------------------------- - -.. automodule:: pywikibot.families.wikipedia_family - -pywikibot.families.wikiquote\_family module -------------------------------------------- - -.. automodule:: pywikibot.families.wikiquote_family - -pywikibot.families.wikisource\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wikisource_family - -pywikibot.families.wikisopore\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wikispore_family - -pywikibot.families.wikitech\_family module ------------------------------------------- - -.. automodule:: pywikibot.families.wikitech_family - -pywikibot.families.wikiversity\_family module ---------------------------------------------- - -.. automodule:: pywikibot.families.wikiversity_family - -pywikibot.families.wikivoyage\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wikivoyage_family - -pywikibot.families.wiktionary\_family module --------------------------------------------- - -.. automodule:: pywikibot.families.wiktionary_family - -pywikibot.families.wowwiki\_family module +:mod:`families.wiktionary\_family` module ----------------------------------------- -.. automodule:: pywikibot.families.wowwiki_family +.. automodule:: families.wiktionary_family +:mod:`families.wowwiki\_family` module +-------------------------------------- + +.. automodule:: families.wowwiki_family diff --git a/docs/api_ref/pywikibot.page.rst b/docs/api_ref/pywikibot.page.rst index 512ecd2..a990fb5 100644 --- a/docs/api_ref/pywikibot.page.rst +++ b/docs/api_ref/pywikibot.page.rst @@ -1,22 +1,22 @@ -pywikibot.page package -======================= +:mod:`page` package +=================== -.. automodule:: pywikibot.page +.. automodule:: page Submodules ---------- -pywikibot.page.\_collections module ------------------------------------ - -.. automodule:: pywikibot.page._collections - -pywikibot.page.\_decorators module ----------------------------------- - -.. automodule:: pywikibot.page._decorators - -pywikibot.page.\_revision module +:mod:`page.\_collections` module -------------------------------- -.. automodule:: pywikibot.page._revision +.. automodule:: page._collections + +:mod:`page.\_decorators` module +------------------------------- + +.. automodule:: page._decorators + +:mod:`page.\_revision` module +----------------------------- + +.. automodule:: page._revision diff --git a/docs/api_ref/pywikibot.pagegenerators.rst b/docs/api_ref/pywikibot.pagegenerators.rst index 5a48ff1..6d5dc64 100644 --- a/docs/api_ref/pywikibot.pagegenerators.rst +++ b/docs/api_ref/pywikibot.pagegenerators.rst @@ -1,20 +1,19 @@ -pagegenerators package -====================== +:mod:`pagegenerators` package +============================= -.. automodule:: pywikibot.pagegenerators +.. automodule:: pagegenerators -pagegenerators.\_factory module -------------------------------- +:mod:`pagegenerators.\_factory` module +-------------------------------------- -.. automodule:: pywikibot.pagegenerators._factory +.. automodule:: pagegenerators._factory -pagegenerators.\_filters module -------------------------------- +:mod:`pagegenerators.\_filters` module +-------------------------------------- -.. automodule:: pywikibot.pagegenerators._filters +.. automodule:: pagegenerators._filters -pagegenerators.\_generators module ----------------------------------- +:mod:`pagegenerators.\_generators` module +----------------------------------------- -.. automodule:: pywikibot.pagegenerators._generators - +.. automodule:: pagegenerators._generators diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst index 3e0e3b6..a12c651 100644 --- a/docs/api_ref/pywikibot.rst +++ b/docs/api_ref/pywikibot.rst @@ -1,7 +1,7 @@ pywikibot package ================= -.. automodule:: pywikibot +#.. automodule:: pywikibot Pywikibot Subpackages --------------------- @@ -21,143 +21,141 @@ Submodules ---------- -pywikibot.backports module --------------------------- +:mod:`backports` module +----------------------- -.. automodule:: pywikibot.backports +.. automodule:: backports -pywikibot.bot module --------------------- +:mod:`bot` module +----------------- -.. automodule:: pywikibot.bot +.. automodule:: bot :member-order: bysource -pywikibot.bot\_choice module ----------------------------- +:mod:`bot\_choice` module +------------------------- -.. automodule:: pywikibot.bot_choice +.. automodule:: bot_choice .. include:: pywikibot.config.rst -pywikibot.cosmetic\_changes module ----------------------------------- +:mod:`cosmetic\_changes` module +------------------------------- -.. automodule:: pywikibot.cosmetic_changes +.. automodule:: cosmetic_changes -pywikibot.daemonize module --------------------------- - -.. automodule:: pywikibot.daemonize - -pywikibot.date module ---------------------- - -.. automodule:: pywikibot.date - -pywikibot.diff module ---------------------- - -.. automodule:: pywikibot.diff - -pywikibot.echo module ---------------------- - -.. automodule:: pywikibot.echo - -pywikibot.editor module +:mod:`daemonize` module ----------------------- -.. automodule:: pywikibot.editor +.. automodule:: daemonize -pywikibot.exceptions module ---------------------------- +:mod:`date` module +------------------ -.. automodule:: pywikibot.exceptions +.. automodule:: date -pywikibot.family module ------------------------ +:mod:`diff` module +------------------ -.. automodule:: pywikibot.family +.. automodule:: diff -pywikibot.fixes module ----------------------- +:mod:`echo` module +------------------ -.. automodule:: pywikibot.fixes +.. automodule:: echo -pywikibot.flow module ---------------------- +:mod:`editor` module +-------------------- -.. automodule:: pywikibot.flow +.. automodule:: editor -pywikibot.i18n module ---------------------- - -.. automodule:: pywikibot.i18n - -pywikibot.interwiki\_graph module ---------------------------------- - -.. automodule:: pywikibot.interwiki_graph - -pywikibot.logentries module ---------------------------- - -.. automodule:: pywikibot.logentries - -pywikibot.logging module +:mod:`exceptions` module ------------------------ +.. automodule:: exceptions + +:mod:`family` module +-------------------- + +.. automodule:: family + +:mod:`fixes` module +------------------- + +.. automodule:: fixes + +:mod:`flow` module +------------------ + +.. automodule:: flow + +:mod:`i18n` module +------------------ + +.. automodule:: i18n + +:mod:`interwiki\_graph` module +------------------------------ + +.. automodule:: interwiki_graph + +:mod:`logentries` module +------------------------ + +.. automodule:: logentries + +:mod:`logging` module +--------------------- + .. automodule:: pywikibot.logging :member-order: bysource -pywikibot.login module +:mod:`login` module +------------------- + +.. automodule:: login + +:mod:`plural` module +-------------------- + +.. automodule:: plural + +:mod:`proofreadpage` module +--------------------------- + +.. automodule:: proofreadpage + +:mod:`site\_detect` module +-------------------------- + +.. automodule:: site_detect + +:mod:`textlib` module +--------------------- + +.. automodule:: textlib + +:mod:`throttle` module ---------------------- -.. automodule:: pywikibot.login +.. automodule:: throttle -pywikibot.plural module ------------------------ - -.. automodule:: pywikibot.plural - -pywikibot.proofreadpage module ------------------------------- - -.. automodule:: pywikibot.proofreadpage - -pywikibot.site\_detect module ------------------------------ - -.. automodule:: pywikibot.site_detect - -pywikibot.textlib module ------------------------- - -.. automodule:: pywikibot.textlib - -pywikibot.throttle module -------------------------- - -.. automodule:: pywikibot.throttle - -pywikibot.time module ---------------------- +:mod:`time` module +------------------ .. automodule:: pywikibot.time -pywikibot.titletranslate module -------------------------------- +:mod:`titletranslate` module +---------------------------- -.. automodule:: pywikibot.titletranslate +.. automodule:: titletranslate -pywikibot.version module ------------------------- +:mod:`version` module +--------------------- -.. automodule:: pywikibot.version +.. automodule:: version -pywikibot.xmlreader module --------------------------- +:mod:`xmlreader` module +----------------------- -.. automodule:: pywikibot.xmlreader - - +.. automodule:: xmlreader diff --git a/docs/api_ref/pywikibot.site.rst b/docs/api_ref/pywikibot.site.rst index cd97c76..9c0abe3 100644 --- a/docs/api_ref/pywikibot.site.rst +++ b/docs/api_ref/pywikibot.site.rst @@ -1,42 +1,49 @@ -pywikibot.site package -======================= +:mod:`site` package +=================== .. automodule:: pywikibot.site :no-members: -BaseSite package ----------------- +:mod:`BaseSite<pywikibot.site._basesite>` package +------------------------------------------------- + .. automodule:: pywikibot.site._basesite -APISite Package ---------------- +:mod:`APISite<pywikibot.site.\_apisite>` Package +------------------------------------------------ + .. automodule:: pywikibot.site._apisite .. automodule:: pywikibot.site._extensions .. automodule:: pywikibot.site._generators -DataSite Package ----------------- +:mod:`DataSite<pywikibot.site.\_datasite>` Package +-------------------------------------------------- + .. automodule:: pywikibot.site._datasite -Obsolete Sites Package ----------------------- +:mod:`Obsolete Sites<pywikibot.site._obsoletesites>` Package +------------------------------------------------------------ + .. automodule:: pywikibot.site._obsoletesites -Siteinfo Package ----------------- +:mod:`Siteinfo<pywikibot.site._siteinfo>` Package +------------------------------------------------- + .. automodule:: pywikibot.site._siteinfo -Namespace Package ------------------ +:mod:`Namespace<pywikibot.site._namespace>` Package +--------------------------------------------------- + .. automodule:: pywikibot.site._namespace -TokenWallet Package -------------------- +:mod:`TokenWallet<pywikibot.site._tokenwallet>` Package +------------------------------------------------------- + .. automodule:: pywikibot.site._tokenwallet -Uploader Package ----------------- -.. automodule:: pywikibot.site._upload +:mod:`Uploader<pywikibot.site._upload>` Package +----------------------------------------------- +.. automodule:: pywikibot.site._upload diff --git a/docs/api_ref/pywikibot.specialbots.rst b/docs/api_ref/pywikibot.specialbots.rst index 8208d51..7a84fe0 100644 --- a/docs/api_ref/pywikibot.specialbots.rst +++ b/docs/api_ref/pywikibot.specialbots.rst @@ -1,4 +1,4 @@ -specialbots package -=================== +:mod:`specialbots` package +========================== -.. automodule:: pywikibot.specialbots +.. automodule:: specialbots diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst index be71273..caff513 100644 --- a/docs/api_ref/pywikibot.tools.rst +++ b/docs/api_ref/pywikibot.tools.rst @@ -1,39 +1,39 @@ -tools package -============= +:mod:`tools` package +==================== -.. automodule:: pywikibot.tools +.. automodule:: tools -tools.chars module ------------------- +:mod:`tools.chars` module +------------------------- -.. automodule:: pywikibot.tools.chars +.. automodule:: tools.chars -tools.collections module +:mod:`tools.collections` module +------------------------------- + +.. automodule:: tools.collections + +:mod:`tools.deprecate` module +----------------------------- + +.. automodule:: tools._deprecate + +:mod:`tools.djvu` module ------------------------ -.. automodule:: pywikibot.tools.collections +.. automodule:: tools.djvu -tools.deprecate module ----------------------- +:mod:`tools.formatter` module +----------------------------- -.. automodule:: pywikibot.tools._deprecate +.. automodule:: tools.formatter -tools.djvu module ------------------ +:mod:`tools.itertools` module +----------------------------- -.. automodule:: pywikibot.tools.djvu +.. automodule:: tools.itertools -tools.formatter module ----------------------- +:mod:`tools.\_logging` module +----------------------------- -.. automodule:: pywikibot.tools.formatter - -tools.itertools module ----------------------- - -.. automodule:: pywikibot.tools.itertools - -tools.\_logging module ----------------------- - -.. automodule:: pywikibot.tools._logging +.. automodule:: tools._logging diff --git a/docs/api_ref/pywikibot.userinterfaces.rst b/docs/api_ref/pywikibot.userinterfaces.rst index 0c05a30..0885943 100644 --- a/docs/api_ref/pywikibot.userinterfaces.rst +++ b/docs/api_ref/pywikibot.userinterfaces.rst @@ -1,51 +1,49 @@ -userinterfaces package -====================== +:mod:`userinterfaces` package +============================= -.. automodule:: pywikibot.userinterfaces +.. automodule:: userinterfaces -\_interface\_base module ------------------------- +:mod:`\_interface\_base` module +------------------------------- -.. automodule:: pywikibot.userinterfaces._interface_base +.. automodule:: userinterfaces._interface_base -terminal\_interface module --------------------------- - -.. automodule:: pywikibot.userinterfaces.terminal_interface - -terminal\_interface\_base module --------------------------------- - -.. automodule:: pywikibot.userinterfaces.terminal_interface_base - -terminal\_interface\_unix module --------------------------------- - -.. automodule:: pywikibot.userinterfaces.terminal_interface_unix - -terminal\_interface\_win32 module +:mod:`terminal\_interface` module --------------------------------- -.. automodule:: pywikibot.userinterfaces.terminal_interface_win32 +.. automodule:: userinterfaces.terminal_interface -buffer\_interface module ------------------------- +:mod:`terminal\_interface\_base` module +--------------------------------------- -.. automodule:: pywikibot.userinterfaces.buffer_interface +.. automodule:: userinterfaces.terminal_interface_base -gui module ----------- +:mod:`terminal\_interface\_unix` module +--------------------------------------- -.. automodule:: pywikibot.userinterfaces.gui +.. automodule:: userinterfaces.terminal_interface_unix -transliteration module ----------------------- +:mod:`terminal\_interface\_win32` module +---------------------------------------- -.. automodule:: pywikibot.userinterfaces.transliteration +.. automodule:: userinterfaces.terminal_interface_win32 -win32\_unicode module ---------------------- +:mod:`buffer\_interface` module +------------------------------- -.. automodule:: pywikibot.userinterfaces.win32_unicode +.. automodule:: userinterfaces.buffer_interface +:mod:`gui` module +----------------- +.. automodule:: userinterfaces.gui + +:mod:`transliteration` module +----------------------------- + +.. automodule:: userinterfaces.transliteration + +:mod:`win32\_unicode` module +---------------------------- + +.. automodule:: userinterfaces.win32_unicode diff --git a/docs/conf.py b/docs/conf.py index e1f2037..a6b12ea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,6 +34,7 @@ docs_dir = dirname(__file__) repo_dir = abspath(join(docs_dir, '..')) +sys.path.insert(0, repo_dir + '/pywikibot') sys.path.insert(0, repo_dir) os.chdir(repo_dir) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/818612 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: Ice63e6754aed80dfd6d5fcb3bfe17137c0954e28 Gerrit-Change-Number: 818612 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits