pywikibot 11.3.0

Python MediaWiki Bot Framework

Pywikibot

The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.31 or higher.

Also included are various general function scripts that can be adapted for different tasks.

For further information about the library excluding scripts see the full code documentation.

Quick start

git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
cd core
git submodule update --init
pip install -r requirements.txt
python pwb.py <script_name>

Or to install using PyPI (excluding scripts)

pip install pywikibot
pwb <scriptname>

Our installation guide has more details for advanced usage.

Basic Usage

If you wish to write your own script it’s very easy to get started:

import pywikibot
site = pywikibot.Site('en', 'wikipedia')  # The site we want to run our bot on
page = pywikibot.Page(site, 'Wikipedia:Sandbox')
page.text = page.text.replace('foo', 'bar')
page.save('Replacing "foo" with "bar"')  # Saves the page

Wikibase Usage

Wikibase is a flexible knowledge base software that drives Wikidata. A sample pywikibot script for getting data from Wikibase:

import pywikibot
site = pywikibot.Site('wikipedia:en')
repo = site.data_repository()  # the Wikibase repository for given site
page = repo.page_from_repository('Q91')  # create a local page for the given item
item = pywikibot.ItemPage(repo, 'Q91')  # a repository item
data = item.get()  # get all item data from repository for this item

Script example

Pywikibot provides bot classes to develop your own script easily:

import pywikibot
from pywikibot import pagegenerators
from pywikibot.bot import ExistingPageBot

class MyBot(ExistingPageBot):

    update_options = {
        'text': 'This is a test text',
        'summary': 'Bot: a bot test edit with Pywikibot.'
    }

    def treat_page(self):
        """Load the given page, do some changes, and save it."""
        text = self.current_page.text
        text += '\n' + self.opt.text
        self.put_current(text, summary=self.opt.summary)

def main():
    """Parse command line arguments and invoke bot."""
    options = {}
    gen_factory = pagegenerators.GeneratorFactory()
    # Option parsing
    local_args = pywikibot.handle_args(args)  # global options
    local_args = gen_factory.handle_args(local_args)  # generators options
    for arg in local_args:
        opt, sep, value = arg.partition(':')
        if opt in ('-summary', '-text'):
            options[opt[1:]] = value
    MyBot(generator=gen_factory.getCombinedGenerator(), **options).run()

if __name == '__main__':
    main()

For more documentation on Pywikibot see our docs.

Roadmap

Release 11.3

• Add until parameter to Site.allpages() and add -until option to Generator Optionsas a stop title for enumeration (T425882)

• Update family.WikimediaFamily.known_codes(T426319)

• Move all families.wikinews_familysite codes to Family.closed_wikis (T425953, T426022)

• Enable CosmeticChangesToolkit.commonsfiledesc() for FILE namespace on on all commons wikis (T425306, T425349)

• Add Devanagari numerals for ne-wiki to NON_ASCII_DIGITS and fix textlib.TimeStripper regex for textlib.TimeStripperPatterns.timezone(T424467)

• Ignore UnicodeDecodeError in cosmetic_changes.CosmeticChangesToolkit.cleanUpLinks and skip the link in such case (T423062)

• Update translations (i18n)

• If preload option is set in pagegenerators.GeneratorFactory.getCombinedGenerator, the preloading generators pagegenerators.PreloadingGeneratoror pagegenerators.DequePreloadingGeneratorare called with the quiet option.

Deprecations

This section lists features, methods, parameters, or attributes that are deprecated and scheduled for removal in future Pywikibot releases.

Deprecated items may still work in the current release but are no longer recommended for use. Users should update their code according to the recommended alternatives.

Pywikibot follows a clear deprecation policy: features are typically deprecated in one release and removed in the third subsequent major release, remaining available for the two releases in between.

Pending removal in Pywikibot 12

• 9.6.0: BaseSite.languages()will be removed in favour of BaseSite.codes

• 9.5.0: DataSite.getPropertyType()will be removed in favour of DataSite.get_property_type()

• 9.3.0: page.BasePage.userNameand page.BasePage.isIpEditare deprecated in favour of user or anon attributes of page.BasePage.latest_revisionproperty

• 9.3.0: botflag parameter of Page.save(), Page.put() and Page.set_redirect_target()was renamed to bot

• 9.2.0: All parameters of Page.templatesand Page.itertemplates()must be given as keyworded arguments

• 9.2.0: Imports of loggingfunctions from the botmodule are deprecated and will be desupported

• 9.2.0: total argument in -logevents pagegenerators option is deprecated; use -limit instead (T128981)

• 9.0.0: The content parameter of proofreadpage.IndexPage.page_genis deprecated and will be ignored (T358635)

• 9.0.0: next parameter of userinterfaces.transliteration.Transliterator.transliteratewas renamed to succ

• 9.0.0: userinterfaces.transliteration.transliterator object was renamed to Transliterator

• 9.0.0: The type parameter of site.APISite.protectedpages() was renamed to protect_type

• 9.0.0: The all parameter of site.APISite.namespace() was renamed to all_ns

• 9.0.0: filter parameter of date.dhwas renamed to filter_func

• 9.0.0: dict parameter of data.api.OptionSetwas renamed to data

• 9.0.0: version.get_toolforge_hostnameis deprecated with no replacement

• 9.0.0: allrevisions parameter of xmlreader.XmlDumpis deprecated, use revisions instead (T340804)

• 9.0.0: iteritems method of data.api.Requestwill be removed in favour of items

• 9.0.0: SequenceOutputter.output() is deprecated in favour of the tools.formatter.SequenceOutputter.outproperty

Pending removal in Pywikibot 13

• 10.7.0: The old (type, value, traceback) signature in tools.collections.GeneratorWrapper.throwwill be removed in Pywikibot 13, or earlier if it is dropped from a future Python release. (T340641)

• 10.6.0: Family.isPublic()will be removed (T407049)

• 10.6.0: Family.interwiki_replacementsis deprecated; use Family.code_aliasesinstead.

• Keyword argument for char parameter of Transliterator.transliterate and positional arguments for prev and succ parameters are deprecated.

• 10.6.0: Positional arguments of daemonize()are deprecated and must be given as keyword arguments.

• 10.5.0: Accessing the fallback ‘*’ keys in ‘languages’, ‘namespaces’, ‘namespacealiases’, and ‘skins’ properties of APISite.siteinfoare deprecated and will be removed.

• 10.5.0: The methods APISite.protection_types() and APISite.protection_levels() are deprecated. APISite.restrictionsshould be used instead.

• 10.4.0: Require all parameters of Site.allpages() except start to be keyword arguments.

• 10.4.0: Positional arguments of pywikibot.Coordinateare deprecated and must be given as keyword arguments.

• 10.3.0: throttle.Throttle.getDelayand throttle.Throttle.setDelayswere renamed to get_delay()and set_delays() ; the old methods will be removed (T289318)

• 10.3.0: throttle.Throttle.next_multiplicityattribute is unused and will be removed (T289318)

• 10.3.0: requestsize parameter of throttle.Throttlecall is deprecated and will be dropped (T289318)

• 10.3.0: textlib.to_latin_digitswill be removed in favour of textlib.to_ascii_digits, NON_LATIN_DIGITS of userinterfaces.transliteration will be removed in favour of NON_ASCII_DIGITS (T398146#10958283)

• 10.2.0: tools.threading.RLockis deprecated and moved to backports module. The backports.RLock.countmethod is also deprecated. For Python 3.14+ use RLock from Python library threading instead. (T395182)

• 10.1.0: revid and date parameters of Page.authorship() were dropped

• 10.0.0: last_id of comms.eventstreams.EventStreamswas renamed to last_event_id (T309380)

• 10.0.0: ‘millenia’ argument for precision parameter of pywikibot.WbTimeis deprecated; ‘millennium’ must be used instead

• 10.0.0: includeredirects parameter of pagegenerators.AllpagesPageGeneratorand pagegenerators.PrefixingPageGeneratoris deprecated and should be replaced by filterredir

Pending removal in Pywikibot 14

• 11.0.0: The User-Agent variable script_product is deprecated; use script instead. The User-Agent variable version is deprecated; use revision instead. The User-Agent variables lang, code and family are deprecated; use site instead.

• 11.0.0: Positional argument for block parameter is deprecated; use a keyword argument instead.

• 11.0.0: Keyword parameters for text_a and text_b of diff.PatchManagerare deprecated. Positional parameters for by_letter and replace_invisible are deprecated.

Release history

See https://github.com/wikimedia/pywikibot/blob/stable/HISTORY.rst

Contributing

Our code is maintained on Wikimedia’s Gerrit installation, learn how to get started.

Code of Conduct

The development of this software is covered by a Code of Conduct.