jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/586402 )
Change subject: [doc] Make BasicBot example a ConfigParserBot to explain the usage
......................................................................
[doc] Make BasicBot example a ConfigParserBot to explain the usage
Change-Id: I0f644e2975772c1b1886e846bc7b872f0051b0be
---
M scripts/basic.py
1 file changed, 18 insertions(+), 2 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/scripts/basic.py b/scripts/basic.py
index 5a767f7..3549691 100755
--- a/scripts/basic.py
+++ b/scripts/basic.py
@@ -23,8 +23,22 @@
-summary: Set the action summary message for the edit.
+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] section like:
-The following generators and filters are supported:
+ [basic] ; inline comments starts with colon
+ # This is a commend line. Assignments may be done with '=' or ':'
+ text: A text with line break and
+ continuing on next line to be put
+ replace: yes ; yes/no, on/off, true/false and 1/0 is also valid
+ summary = Bot: My first test edit with pywikibot
+
+Every script has its own section with the script name as header.
+
+In addition the following generators and filters are supported but
+cannot be set by settings file:
¶ms;
"""
@@ -37,7 +51,8 @@
from pywikibot import pagegenerators
from pywikibot.bot import (
- SingleSiteBot, ExistingPageBot, NoRedirectPageBot, AutomaticTWSummaryBot)
+ SingleSiteBot, ConfigParserBot, ExistingPageBot, NoRedirectPageBot,
+ AutomaticTWSummaryBot)
from pywikibot.tools import PYTHON_VERSION
if PYTHON_VERSION >= (3, 9):
@@ -53,6 +68,7 @@
class BasicBot(
# Refer pywikobot.bot for generic bot classes
SingleSiteBot, # A bot only working on one site
+ ConfigParserBot, # A bot which reads options from scripts.ini setting file
# CurrentPageBot, # Sets 'current_page'. Process it in treat_page method.
# # Not needed here because we have subclasses
ExistingPageBot, # CurrentPageBot which only treats existing pages
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/586402
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: I0f644e2975772c1b1886e846bc7b872f0051b0be
Gerrit-Change-Number: 586402
Gerrit-PatchSet: 5
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-CC: Dvorapa <dvorapa(a)seznam.cz>
Gerrit-CC: Mpaa <mpaa.wiki(a)gmail.com>
Gerrit-MessageType: merged