Manual:Pywikibot/replace.py

Replace.py is part of the  framework.

This bot replaces text. It will retrieve information on which pages might need changes either from an XML dump or a text file, or only change a single page. To get some more information, use:

If you have Windows, you may omit " ".

Overview
You may use this script basically in two ways:


 * 1) You write all the parameters into the command line, including the text to be replaced and the replacement.  This is useful for simple tasks.  For example,   will search for word "color" only in articles ( ), changes the lower case occurrences to "colour", asks you each time to confirm the replacement, and uses the default edit comment.  Be careful, because there are cases where color must not be changed to colour (e.g. in article Cascading Style Sheets); never run such a replacement automatically unless you are at least 100% sure it is always correct!  This is almost the simplest form of the command (see below at the minimal parameters).    is equivalent to writing the word <tvar|1>color</> into the search bar and is a fast way of gathering articles, but will not find <tvar|2>colored</> and <tvar|3>colors</>.
 * Should either the old or the new text contain spaces, use quotation marks!
 * Repeated tasks may be stored in a batch file (Windows) or shell script (Linux).
 * 1) You store the main parameters, including old and new text, exceptions and edit comment in a file.  Several tasks (called fixes) may be stored in one file and used repeatedly.  This file may be either <tvar|1> </> which is included in your pywikibot distribution, but is subject to change at every update, so you have to save it for yourself, or <tvar|2> </> that is designed for personal use, but is not included in Pywiki and may be created with <tvar|3> </>.  This latter one has a slightly different syntax, but has an example.  This is much more efficient and flexible but needs some preparation.  These two methods may be combined; however, some parameters stored in the fix will overwrite corresponding parameter given in command line.

Once you have chosen between these options, you have another decision:


 * 1) You make simple text replacements like the above one. This is a good way for changing words, templates, categories, section titles or names, but is not flexible. For example, the above command will replace "color", but not colors, colored and Color in upper case. (If you are worried only about the case, you may still type  .)
 * 2) You use regular expressions (often mentioned as regexes). These seek patterns and replace them with patterns. There are some examples in . For agglutinative and inflecting languages this is the only efficient way of spelling corrections.

Your third decision will be this:


 * 1) You search for pages to be modified in the live wiki. This will result in acceptable speed if you work with templates, categories or the search engine, but is usually very slow for simple iteration of pages, especially in large and medium sized wikis. So  is the least recommended way of usage as it wastes your time and the resources of the server. (However, sometimes it is necessary and unavoidable if your wiki does not have dumps.)
 * 2) You download an XML dump of your wiki from https://dumps.wikimedia.org (usually xxwiki-latest-pages-articles.xml.bz2) and use it with . This will speed up your bot and use your time as well as the time of your computer and the server more efficiently. This is the recommended way of searching for color, colors and colored together, because the search engine unfortunately does not handle regexes. The disadvantage of this method is that you won't find articles into which the given text has got since the composition of the last dump.
 * Direct access to the dumps of your wiki is something like huwiki/. Change the first two letters to your language code.
 * Dumps at the given link are available only for Wikimedia wikis. For other wikis, contact the maintainer of that wiki to learn if they have dumps.

And, last but not least, you face one more decision:
 * 1) You search for pages and modify them on the fly. This will again result in acceptable speed if you work with templates, categories or the search engine, but may be very slow if you just search for a regex in the complete namespace or wiki.

At least these data should be given for the bot every time:
 * Minimal set of parameters
 * 1) Where and how to search for the pages to be edited?
 * The corresponding parameter may be any of  etc.; see the Source section of the below table.
 * 1) The old text to be replaced and the new one to be substituted.
 * This may be one or more pairs of strings or the name of a fix.
 * 1) It is not mandatory, but usually worth and strongly recommended for beginners to limit the work to the main namespace with . Thus you can avoid changing the contributions of users on talk pages or correcting the title of an article on a page where the talk is just about that title. Visible part of templates (but not the code itself!) and file descriptions are also in the scope of readers. It is better not to modify talk pages, user pages and project pages (the "Wikipedia" namespace) in the first time, and it needs special care and community consensus even later. Don't be surprised of angry reactions or your bot being blocked if you omit the namespace parameter.

Files
The bot uses three files in addition to the framework:


 * : the main module
 * : a few predefined "fixes"
 * : a file to add ones own fixes. The file is created nearly empty by

Files that may be used for input and/or output:
 * : a file with a list of articles if specified with the parameter "-file"


 * : a local XML dump if used with parameter "-xml"
 * : the log with a name that may be specified with parameter "-log"

Local
You can run replace.py with the following parameters (for example, ).

Examples
If you want to change templates from the old syntax, e.g., to the new syntax, e.g., download an XML dump file (page table) from https://dumps.wikimedia.org, then use this command:

You can match patterns across more than one line:

You can insert or append text to a page (note the replacement text has embedded new lines):

If you have a dump called foobar.xml and want to fix typos, e.g. Errror -> Error, use this:

If you have a page called 'John Doe' and want to convert HTML tags to wiki syntax, use:

If you run the bot without arguments you will be prompted multiple times for replacements:

The script asks the user before modifying an article. It is recommended to double-check the result to be sure that the bot did not introduce errors (especially with misspelled words). It is possible to specify a set of articles with an external text file containing Wiki links :

The bot is then called using something like:

Rather than specifying regular expressions at the command line, it's preferable to add them to

Example: Replacing multiple paragraphs
The original text of the page Sandbox is: This page is for any tests.

Welcome to the sandbox!

If you want to switch the statement (the second one goes before the first one), you type the following syntax:

To add a new line we use.

Example: Plenty of unbolding within an article
In this article there were really lots of bolded episode titles in several tables that were to be unbolded. This is the case when you may want to use a bot for one single article and this shows the role of some interesting parameters.


 * What are we looking for?
 * Texts between pairs of ,
 * which are within a table (we don't want to replace in the rest of the article!),
 * but do not contain a  character (just for safety, to make sure we are still within one cell — we might perhaps omit this),
 * paying attention to having many occurrences within a table (recursion),
 * and that the tables are wrapped to several lines (dotall),
 * and that every table opening tag should match its own closing tag and every beginning of bold text should match its own closing  (that's why we use  s to make the expressions ungreedy).

With the text parts before, between and after the boldings — these are put in parentheses to be able to refer to them with their group numbers, respectively.
 * What do we replace it with?

(It is wrapped here for readability, but you should write to one line, of course.) The bot will ask for the title since we have not given it. Using double quotation marks fits to the command line and gives the freedom to use apostrophes in the expression.
 * The command

Here you are. (Don't click if your computer is not strong enough!)
 * Result:

Advanced use of fixes: own functions
Being a wizard by means of replace.py is not a dream if you are familiar with the basics of Python programming. textlib.py (another module of the pywikibot framework) has a wonderful but not widely used ability. If you write a function instead of a constant text or a regular expression to the replacement text or the exceptions, it will recognize and execute it. With a little bit of programming you may take advantage of this feature, and use replace.py at a higher level. Needless to say, using an own function gives much more flexibility than a simple regex. You may also use a function to generate the replacement expressions so as to keep them clearly arranged.

To learn how to use your own functions in fixes.py and user-fixes.py and what is this good for, see hu:Szerkesztő:Bináris/Fixes and functions HOWTO.