template.py
29c74775bc13master

template.py
View Options

			#!/usr/bin/env python3
			r"""
			Very simple script to replace a template with another one.

			It also converts the old MediaWiki boilerplate format to the new format.

			Syntax:

			python pwb.py template [-remove] [xml[:filename]] oldTemplate \
			[newTemplate]

			Specify the template on the command line. The program will pick up the template
			page, and look for all pages using it. It will then automatically loop over
			them, and replace the template.

			Command line options:

			-remove Remove every occurrence of the template from every article

			-subst Resolves the template by putting its text directly into the
			article. This is done by changing {{...}} or {{msg:...}} into
			{{subst:...}}. If you want to use safesubst, you
			can do -subst:safe. Substitution is not available inside
			<ref>...</ref>, <gallery>...</gallery>, <poem>...</poem>
			and <pagelist ... /> tags.

			-assubst Replaces the first argument as old template with the second
			argument as new template but substitutes it like -subst does.
			Using both options -remove and -subst in the same command line has
			the same effect.

			-xml retrieve information from a local dump
			(https://dumps.wikimedia.org). If this argument isn't given,
			info will be loaded from the maintenance page of the live wiki.
			argument can also be given as "-xml:filename.xml".

			-onlyuser: Only process pages edited by a given user

			-skipuser: Only process pages not edited by a given user

			-timestamp: (With -onlyuser or -skipuser). Only check for a user where his
			edit is not older than the given timestamp. Timestamp must be
			written in MediaWiki timestamp format which is "%Y%m%d%H%M%S".
			If this parameter is missed, all edits are checked but this is
			restricted to the last 100 edits.

			-summary: Lets you pick a custom edit summary. Use quotes if edit summary
			contains spaces.

			-always Don't bother asking to confirm any of the changes, Just Do It.

			-addcat: Appends the given category to every page that is edited. This is
			useful when a category is being broken out from a template
			parameter or when templates are being upmerged but more
			information must be preserved.

			other: First argument is the old template name, second one is the new
			name.
			If you want to address a template which has spaces, put quotation
			marks around it, or use underscores.

			Examples
			--------

			If you have a template called [[Template:Cities in Washington]] and want to
			change it to [[Template:Cities in Washington state]], start:

			python pwb.py template "Cities in Washington" "Cities in Washington state"

			Move the page [[Template:Cities in Washington]] manually afterwards.


			If you have a template called [[Template:test]] and want to substitute it only
			on pages in the User: and User talk: namespaces, do:

			python pwb.py template test -subst -namespace:2 -namespace:3

			.. note:: -namespace: is a global Pywikibot parameter

			This next example substitutes the template lived with a supplied edit summary.
			It only performs substitutions in main article namespace and doesn't prompt to
			start replacing. Note that -putthrottle: is a global Pywikibot parameter:

			python pwb.py template -putthrottle:30 -namespace:0 lived -subst -always \
			-summary:"BOT: Substituting {{lived}}, see [[WP:SUBST]]."

			This next example removes the templates {{cfr}}, {{cfru}}, and {{cfr-speedy}}
			from five category pages as given:

			python pwb.py template cfr cfru cfr-speedy -remove -always \
			-page:"Category:Mountain monuments and memorials" \
			-page:"Category:Indian family names" \
			-page:"Category:Tennis tournaments in Belgium" \
			-page:"Category:Tennis tournaments in Germany" \
			-page:"Category:Episcopal cathedrals in the United States" \
			-summary:"Removing Cfd templates from category pages that survived."

			This next example substitutes templates test1, test2, and space test on all
			user talk pages (namespace #3):

			python pwb.py template test1 test2 "space test" -subst -ns:3 -always
			"""
			#
			# (C) Pywikibot team, 2003-2023
			#
			# Distributed under the terms of the MIT license.
			#
			from __future__ import annotations

			import re

			import pywikibot
			from pywikibot import i18n, pagegenerators, textlib
			from pywikibot.backports import batched
			from pywikibot.bot import SingleSiteBot
			from pywikibot.pagegenerators import XMLDumpPageGenerator
			from pywikibot.tools.itertools import filter_unique, roundrobin_generators
			from scripts.replace import ReplaceRobot as ReplaceBot


			class TemplateRobot(ReplaceBot):

			"""This bot will replace, remove or subst all occurrences of a template."""

			update_options = {
			'addcat': None,
			'remove': False,
			'subst': False,
			'summary': '',
			}

			def __init__(self, generator, templates: dict, **kwargs) -> None:
			"""
			Initializer.

			:param generator: the pages to work on
			:type generator: iterable
			:param templates: a dictionary which maps old template names to
			their replacements. If remove or subst is True, it maps the
			names of the templates that should be removed/resolved to None.
			"""
			SingleSiteBot.__init__(self, **kwargs)

			self.templates = templates

			# get edit summary message if it's empty
			if not self.opt.summary:
			comma = self.site.mediawiki_message('comma-separator')
			params = {'list': comma.join(self.templates.keys()),
			'num': len(self.templates)}

			if self.opt.remove:
			tw_key = 'template-removing'
			elif self.opt.subst:
			tw_key = 'template-substituting'
			else:
			tw_key = 'template-changing'
			self.opt.summary = i18n.twtranslate(self.site, tw_key, params)

			replacements = []
			exceptions = {}
			builder = textlib.MultiTemplateMatchBuilder(self.site)
			for old, new in self.templates.items():
			template_regex = builder.pattern(old)

			if self.opt.subst and self.opt.remove:
			replacements.append((template_regex,
			r'{{subst:%s\g<parameters>}}' % new))
			exceptions['inside-tags'] = ['ref', 'gallery', 'poem',
			'pagelist', ]
			elif self.opt.subst:
			replacements.append(
			(template_regex, r'{{%s:%s\g<parameters>}}' %
			(self.opt.subst, old)))
			exceptions['inside-tags'] = ['ref', 'gallery', 'poem',
			'pagelist', ]
			elif self.opt.remove:
			separate_line_regex = re.compile(
			fr'^[#:] {template_regex.pattern} \n',
			re.DOTALL \| re.MULTILINE)
			replacements.append((separate_line_regex, ''))

			spaced_regex = re.compile(
			fr' +{template_regex.pattern} +',
			re.DOTALL)
			replacements.append((spaced_regex, ' '))

			replacements.append((template_regex, ''))
			else:
			template = pywikibot.Page(self.site, new, ns=10)
			if not template.exists():
			pywikibot.warning(f'Template "{new}" does not exist.')
			if not pywikibot.input_yn('Do you want to proceed anyway?',
			default=False,
			automatic_quit=False):
			continue
			replacements.append((template_regex,
			r'{{%s\g<parameters>}}' % new))

			super().__init__(
			generator, replacements, exceptions,
			always=self.opt.always,
			addcat=self.opt.addcat,
			summary=self.opt.summary)


			def main(*args: str) -> None:
			"""
			Process command line arguments and invoke bot.

			If args is an empty list, sys.argv is used.

			:param args: command line arguments
			"""
			template_names = []
			options = {}
			# If xmlfilename is None, references will be loaded from the live wiki.
			xmlfilename = None
			user = None
			skip = False
			timestamp = None

			# read command line parameters
			local_args = pywikibot.handle_args(args)

			site = pywikibot.Site()
			gen_factory = pagegenerators.GeneratorFactory()
			for arg in local_args:
			if arg == '-remove':
			options['remove'] = True
			elif arg.startswith('-subst'):
			options['subst'] = arg[len('-subst:'):] + 'subst'
			assert options['subst'] in ('subst', 'safesubst')
			elif arg == '-assubst':
			options['subst'] = 'subst'
			options['remove'] = True
			elif arg == '-always':
			options['always'] = True
			elif arg.startswith('-xml'):
			if len(arg) == 4:
			xmlfilename = pywikibot.input(
			"Please enter the XML dump's filename: ")
			else:
			xmlfilename = arg[5:]
			elif arg.startswith('-addcat:'):
			options['addcat'] = arg[len('-addcat:'):]
			elif arg.startswith('-summary:'):
			options['summary'] = arg[len('-summary:'):]
			elif arg.startswith('-onlyuser:'):
			user = arg[len('-onlyuser:'):]
			elif arg.startswith('-skipuser:'):
			user = arg[len('-skipuser:'):]
			skip = True
			elif arg.startswith('-timestamp:'):
			timestamp = arg[len('-timestamp:'):]
			else:
			if not gen_factory.handle_arg(arg):
			template_name = pywikibot.Page(site, arg, ns=10)
			template_names.append(template_name.title(with_ns=False))

			if not template_names:
			pywikibot.bot.suggest_help(missing_parameters=['templates'])
			return

			if bool(options.get('subst', False)) ^ options.get('remove', False):
			templates = dict.fromkeys(template_names)
			else:
			try:
			templates = dict(batched(template_names, 2))
			except ValueError:
			pywikibot.info('Unless using solely -subst or -remove, you must '
			'give an even number of template names.')
			return

			old_templates = [pywikibot.Page(site, template_name, ns=10)
			for template_name in templates]

			if xmlfilename:
			builder = textlib.MultiTemplateMatchBuilder(site)
			predicate = builder.search_any_predicate(old_templates)

			gen = XMLDumpPageGenerator(
			xmlfilename, site=site, text_predicate=predicate)
			else:
			gen = gen_factory.getCombinedGenerator()

			if not gen:
			gens = (
			t.getReferences(only_template_inclusion=True,
			follow_redirects=False)
			for t in old_templates
			)
			gen = roundrobin_generators(*gens)
			gen = filter_unique(gen, key=lambda p: '{}:{}:{}'.format(*p._cmpkey()))
			if user:
			gen = pagegenerators.UserEditFilterGenerator(gen, user, timestamp,
			skip,
			max_revision_depth=100,
			show_filtered=True)

			if not gen_factory.gens:
			# make sure that proper namespace filtering etc. is handled
			gen = gen_factory.getCombinedGenerator(gen)

			if not gen_factory.nopreload:
			gen = pagegenerators.PreloadingGenerator(gen)

			bot = TemplateRobot(gen, templates, site=site, **options)
			bot.run()


			if __name__ == '__main__':
			main()

rPWBC/scripts/template.py29c74775bc13master

template.pyView Options

rPWBC/scripts/template.py
29c74775bc13master

template.py
View Options