			#!/usr/bin/python
			# -- coding: utf-8 --
			"""
			This is not a complete bot; rather, it is a template from which simple
			bots can be made. You can rename it to mybot.py, then edit it in
			whatever way you want.

			The following parameters are supported:

			&params;

			-dry If given, doesn't do any real changes, but only shows
			what would have been changed.

			All other parameters will be regarded as part of the title of a single page,
			and the bot will only work on that single page.
			"""
			#
			# (C) Pywikibot team, 2006-2014
			#
			# Distributed under the terms of the MIT license.
			#
			__version__ = '$Id$'
			#

			import pywikibot
			from pywikibot import pagegenerators
			from pywikibot import i18n

			# This is required for the text that is shown when you run this script
			# with the parameter -help.
			docuReplacements = {
			'&params;': pagegenerators.parameterHelp
			}


			class BasicBot:
			# Edit summary message that should be used is placed on /i18n subdirectory.
			# The file containing these messages should have the same name as the caller
			# script (i.e. basic.py in this case)

			def __init__(self, generator, dry):
			"""
			Constructor. Parameters:
			@param generator: The page generator that determines on which pages
			to work.
			@type generator: generator.
			@param dry: If True, doesn't do any real changes, but only shows
			what would have been changed.
			@type dry: boolean.
			"""
			site = pywikibot.Site()
			self.generator = generator
			self.dry = dry
			# Set the edit summary message
			self.summary = i18n.twtranslate(site, 'basic-changing')

			def run(self):
			for page in self.generator:
			self.treat(page)

			def treat(self, page):
			"""
			Loads the given page, does some changes, and saves it.
			"""
			text = self.load(page)
			if not text:
			return

			################################################################
			# NOTE: Here you can modify the text in whatever way you want. #
			################################################################

			# If you find out that you do not want to edit this page, just return.
			# Example: This puts the text 'Test' at the beginning of the page.
			text = 'Test ' + text

			if not self.save(text, page, self.summary):
			pywikibot.output(u'Page %s not saved.' % page.title(asLink=True))

			def load(self, page):
			"""
			Loads the given page, does some changes, and saves it.
			"""
			try:
			# Load the page
			text = page.get()
			except pywikibot.NoPage:
			pywikibot.output(u"Page %s does not exist; skipping."
			% page.title(asLink=True))
			except pywikibot.IsRedirectPage:
			pywikibot.output(u"Page %s is a redirect; skipping."
			% page.title(asLink=True))
			else:
			return text
			return None

			def save(self, text, page, comment=None, minorEdit=True,
			botflag=True):
			# only save if something was changed
			if text != page.get():
			# Show the title of the page we're working on.
			# Highlight the title in purple.
			pywikibot.output(u"\n\n>>> \03{lightpurple}%s\03{default} <<<"
			% page.title())
			# show what was changed
			pywikibot.showDiff(page.get(), text)
			pywikibot.output(u'Comment: %s' % comment)
			if not self.dry:
			choice = pywikibot.inputChoice(
			u'Do you want to accept these changes?',
			['Yes', 'No'], ['y', 'N'], 'N')
			if choice == 'y':
			try:
			page.text = text
			# Save the page
			page.save(comment=comment or self.comment,
			minor=minorEdit, botflag=botflag)
			except pywikibot.LockedPage:
			pywikibot.output(u"Page %s is locked; skipping."
			% page.title(asLink=True))
			except pywikibot.EditConflict:
			pywikibot.output(
			u'Skipping %s because of edit conflict'
			% (page.title()))
			except pywikibot.SpamfilterError as error:
			pywikibot.output(
			u'Cannot change %s because of spam blacklist entry %s'
			% (page.title(), error.url))
			else:
			return True
			return False


			def main():
			global site

			# Process global arguments to determine desired site
			local_args = pywikibot.handleArgs()
			site = pywikibot.Site()

			# This factory is responsible for processing command line arguments
			# that are also used by other scripts and that determine on which pages
			# to work on.
			genFactory = pagegenerators.GeneratorFactory()
			# The generator gives the pages that should be worked upon.
			gen = None
			# This temporary array is used to read the page title if one single
			# page to work on is specified by the arguments.
			pageTitleParts = []
			# If dry is True, doesn't do any real changes, but only show
			# what would have been changed.
			dry = False

			# Parse command line arguments
			for arg in local_args:
			if arg.startswith("-dry"):
			dry = True
			else:
			# check if a standard argument like
			# -start:XYZ or -ref:Asdf was given.
			if not genFactory.handleArg(arg):
			pageTitleParts.append(arg)

			site.login()
			if pageTitleParts != []:
			# We will only work on a single page.
			pageTitle = ' '.join(pageTitleParts)
			page = pywikibot.Page(pywikibot.Link(pageTitle, site))
			gen = iter([page])

			if not gen:
			gen = genFactory.getCombinedGenerator()
			if gen:
			# The preloading generator is responsible for downloading multiple
			# pages from the wiki simultaneously.
			gen = pagegenerators.PreloadingGenerator(gen)
			bot = BasicBot(gen, dry)
			bot.run()
			else:
			pywikibot.showHelp()

			if __name__ == "__main__":
			main()

rPWBC/scripts/basic.py
75397bd7ec25master

basic.py
View Options

rPWBC/scripts/basic.py75397bd7ec25master

basic.pyView Options

rPWBC/scripts/basic.py
75397bd7ec25master

basic.py
View Options