pywikibot 8.0.0

Python MediaWiki Bot Framework

Pywikibot

The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.27 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

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

Or to install using PyPI (excluding scripts)

pip install -U setuptools
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

Current release 8.0.0

Improvements

• Allow copying timezone from timestamp in pywikibot.WbTime(T325864)

• Support federated Wikibase (T173195)

• Improve warning if a Non-JSON response was received from server (T326046)

• Allow normalization of pywikibot.WbTimeobjects (T123888)

• Add parser for <pages /> tag to proofreadpage

• addOnly parameter of textlib.replaceLanguageLinksand textlib.replaceCategoryLinks were renamed to add_only

• known_codes attribute was added to family.WikimediaFamily(T325426)

• Unify representation for time.Timestampbetween CPython and Pypy (T325905)

• Implement comparison for pywikibot.WbTimeobject (T148280, T325863)

• Create a cookie file for each account (T324000)

• Move data.api._login.LoginManager to login.ClientLoginManager

• Let user the choice which section to be copied with generate_user_files (T145372)

• use roundrobin_generatorsto combine generators when limit option is given

• Ignore OSError if API cache cannot be written

• Update tools._unidata._category_cf from Unicodedata version 15.0.0

• Timestamp.set_timestamp()raises TypeError instead of ValueError if conversion fails

• Python 3.12 is supported

• All parameters of APISite.categorymembers() are provided with Category.members(), Category.subcategories()(member_type excluded) and Category.articles()(member_type excluded)

• Enable site-package installation from git repository (T320851)

• Enable 2FA login (T186274)

• Page.editTime()was replaced by Page.latest_revision.timestamp

• Raise a generic ServerError if requests response is a ServerError (T320590)

• Add a new variable ‘private_folder_permission’ to config.py (T315045)

• L10N and i18n updates

• Adjust subprocess args in tools.djvu

• Short site value can be given if site code is equal to family like -site:meta or -site:commons

Documentation improvements

• Add highlighting to targeted code snippet within documentation (T323800)

• Add previous, next, index, and modules links to documentation sidebar (T323803)

• Introduce standard colors (legacy palette) in Furo theme (T323802)

• Improve basic content structure and navigation of documentation (T323812)

• Use Furo sphinx theme instead of Natural and improve documentation look and feel (T322212)

• MediaWiki API cross reference was added to the documentation

Bugfixes

• Fix representation string for page.Claimstub instances (T326453)

• Don’t raise StopIteration in login.LoginManager.check_user_exists if given user is behind the last user (T326063)

• Normalize WbTimessent to Wikidata (T325860)

• Fix pywikibot.WbTimeprecision (T324798)

• Unquote title for red-links in class:proofreadpage.IndexPage

• Find month with first letter uppercase or lowercase with textlib.TimeStripper(T324310)

• Fix disolving script_paths for site-package (T320530)

• Respect limit argument with Board.topics() (T138215, T138307)

Breaking changes

• mwparserfromhell package is mandatory (T326498)

• Several package dependencies were updated

• All parameters of Category.members(), Category.subcategories()and Category.articles()are keyword only

• The parent_id and content_model attributes of page.Revisionwere removed in favour of parentid and contentmodel

• Support for MediaWiki < 1.27 was dropped

• ListBoxWindows class of userinterfaces.guiwas removed

• Require Python 3.6.1+ with Pywikibot and drop support for Python 3.6.0 (T318912)

• pymysql >= 0.9.3 is required (T216741)

• Python 3.5 support was dropped (T301908)

• See also Code cleanups below

Code cleanups

• maintenance/sorting_order script was removed (T325426)

• alphabetic_sv and interwiki_putfirst attributes of Wiktionaryfamily were removed (T325426)

• alphabetic, alphabetic_revised and fyinterwiki attributes of family.Family were removed (T325426)

• See also Deprecations below

Deprecations

• 8.0.0: Timestamp.clone()method is deprecated in favour of Timestamp.replace() method.

• 8.0.0: family.Family.maximum_GET_lengthmethod is deprecated in favour of config.maximum_GET_length(T325957)

• 8.0.0: addOnly parameter of textlib.replaceLanguageLinksand textlib.replaceCategoryLinksare deprecated in favour of add_only

• 8.0.0: textlib.TimeStripperregex attributes ptimeR, ptimeznR, pyearR, pmonthR, pdayR are deprecated in favour of patterns attribute which is a textlib.TimeStripperPatterns.

• 8.0.0: textlib.TimeStripper``groups`` attribute is deprecated in favour of textlib.TIMEGROUPS

• 8.0.0: LoginManager.get_login_tokenwas replaced by login.ClientLoginManager.site.tokens['login']

• 8.0.0: data.api.LoginManager() is deprecated in favour of login.ClientLoginManager

• 8.0.0: APISite.messages()method is deprecated in favour of userinfo[‘messages’]

• 8.0.0: Page.editTime()method is deprecated and should be replaced by Page.latest_revision.timestamp

• 7.7.0: tools.threadingclasses should no longer imported from tools

• 7.6.0: tools.itertoolsdatatypes should no longer imported from tools

• 7.6.0: tools.collectionsdatatypes should no longer imported from tools

• 7.5.0: textlib.tzoneFixedOffset class will be removed in favour of time.TZoneFixedOffset

• 7.4.0: FilePage.usingPages() was renamed to using_pages()

• 7.2.0: tb parameter of exception()function was renamed to exc_info

• 7.2.0: XMLDumpOldPageGenerator is deprecated in favour of a content parameter of XMLDumpPageGenerator(T306134)

• 7.2.0: RedirectPageBot and NoRedirectPageBot bot classes are deprecated in favour of use_redirectsattribute

• 7.2.0: tools.formatter.color_formatis deprecated and will be removed

• 7.1.0: Unused get_redirect parameter of Page.getOldVersion() will be removed

• 7.1.0: APISite._simple_request() will be removed in favour of APISite.simple_request()

• 7.0.0: User.isBlocked() method is renamed to is_blocked for consistency

• 7.0.0: Private BaseBot counters _treat_counter, _save_counter, _skip_counter will be removed in favour of collections.Counter counter attribute

• 7.0.0: A boolean watch parameter in Page.save() is deprecated and will be desupported

• 7.0.0: baserevid parameter of editSource(), editQualifier(), removeClaims(), removeSources(), remove_qualifiers() DataSite methods will be removed

• 7.0.0: Values of APISite.allpages() parameter filterredir other than True, False and None are deprecated

• 7.0.0: The i18n identifier ‘cosmetic_changes-append’ will be removed in favour of ‘pywikibot-cosmetic-changes’

• 6.5.0: OutputOption.output() method will be removed in favour of OutputOption.out property

• 6.5.0: Infinite rotating file handler with logfilecount of -1 is deprecated

• 6.4.0: ‘allow_duplicates’ parameter of tools.itertools.intersect_generatorsas positional argument is deprecated, use keyword argument instead

• 6.4.0: ‘iterables’ of tools.itertools.intersect_generatorsgiven as a list or tuple is deprecated, either use consecutive iterables or use ‘*’ to unpack

• 6.2.0: outputter of OutputProxyOption without out property is deprecated

• 6.2.0: ContextOption.output_range() and HighlightContextOption.output_range() are deprecated

• 6.2.0: Error messages with ‘%’ style is deprecated in favour for str.format() style

• 6.2.0: page.url2unicode() function is deprecated in favour of tools.chars.url2string()

• 6.2.0: Throttle.multiplydelay attribute is deprecated

• 6.2.0: SequenceOutputter.format_list() is deprecated in favour of ‘out’ property

• 6.0.0: config.register_family_file() is deprecated

• 5.5.0: APISite.redirectRegex() will be removed in favour of APISite.redirect_regex()

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.