pywikibot

.. image:: https://github.com/wikimedia/pywikibot/actions/workflows/pywikibot-ci.yml/badge.svg?branch=master :alt: GitHub CI :target: https://github.com/wikimedia/pywikibot/actions/workflows/pywikibot-ci.yml .. image:: https://codecov.io/gh/wikimedia/pywikibot/branch/master/graph/badge.svg :alt: Code coverage :target: https://app.codecov.io/gh/wikimedia/pywikibot .. image:: https://api.codeclimate.com/v1/badges/de6ca4c66e7c7bee4156/maintainability :alt: Maintainability :target: https://codeclimate.com/github/wikimedia/pywikibot .. image:: https://img.shields.io/pypi/pyversions/pywikibot.svg :alt: Python :target: https://www.python.org/downloads/ .. image:: https://img.shields.io/github/languages/top/wikimedia/pywikibot :alt: Top language :target: https://www.python.org/downloads/ .. image:: https://img.shields.io/pypi/v/pywikibot.svg :alt: Pywikibot release :target: https://pypi.org/project/pywikibot/ .. image:: https://img.shields.io/pypi/wheel/pywikibot :alt: wheel :target: https://pypi.org/project/pywikibot/ .. image:: https://static.pepy.tech/badge/pywikibot :alt: Total downloads :target: https://pepy.tech/project/pywikibot .. image:: https://static.pepy.tech/personalized-badge/pywikibot?period=month&units=international_system&left_color=black&right_color=blue&left_text=monthly :alt: Monthly downloads :target: https://pepy.tech/project/pywikibot .. image:: https://img.shields.io/github/last-commit/wikimedia/pywikibot :alt: Last commit :target: https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/

---

Pywikibot

---

The Pywikibot framework is a Python library that interfaces with the MediaWiki API <https://www.mediawiki.org/wiki/API:Main_page>_ 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 <https://doc.wikimedia.org/pywikibot/stable/>_.

Quick start

.. code:: text

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)

.. code:: text

pip install pywikibot
pwb <scriptname>

Our installation guide <https://www.mediawiki.org/wiki/Manual:Pywikibot/Installation>_ has more details for advanced usage.

Basic Usage

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

.. code:: python

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:

.. code:: python

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:

.. code:: python

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 <https://doc.wikimedia.org/pywikibot/>_.

Roadmap

Current Release Changes

• Add support for idwikivoyage (T381082)
• Add docstrings of tools.classpropertymethods (T380628)
• Site property BaseSite.codeswas added (T380606)
• Increase leeway parameter of login.OauthLoginManager.identity(T380270)
• Show a warning if ignore_extension parameter of pywikibot.FilePagewas set and the extension is invalid
• Remove old code of Python 3.2 or older in tools.chars.replace_invisibledue to 393
• use BasePage.autoFormat()instead of date.getAutoFormatin titletranslate
• Upcast pywikibot.Pageto pywikibot.FilePagein PageGenerator.result() if imageinfo is given (T379513)
• Update oauth requirements
• i18n-updates
• Implement param with_sort_key in page.BasePage.categories(T75561)
• Python 3.7 support will be discontinued and probably this is the last version supporting it
• Add page.BasePage.get_revisionmethod
• Retry data.sparql.SparqlQuery.queryon internal server error (500) (T378788)
• Extract APISite.linktrail() for hr-wiki (T378787)

Current Deprecations

• 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.4.0: flowsupport is deprecated and will be removed (T371180)

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

• 9.2.0: Imports of loggingfunctions from botmodule is 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: userinterfaces.transliteration.transliterator was renamed to Transliterator

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

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

• 9.0.0: 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: pywikibot.version.get_toolforge_hostname() is deprecated without replacement

• 9.0.0: allrevisions parameter of xmlreader.XmpDumpis 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 tools.formatter.SequenceOutputter.out property

• 9.0.0: nullcontext context manager and SimpleQueue queue of backportsare derecated

• 8.4.0: modules_only_mode parameter of data.api.ParamInfo, its paraminfo_keys class attribute and its preloaded_modules property will be removed

• 8.4.0: dropdelay and releasepid attributes of throttle.Throttlewill be removed in favour of expiry class attribute

• 8.2.0: tools.itertools.itergroupwill be removed in favour of backports.batched

• 8.2.0: normalize parameter of WbTime.toTimestrand WbTime.toWikibasewill be removed

• 8.1.0: Dependency of exceptions.NoSiteLinkErrorfrom exceptions.NoPageErrorwill be removed

• 8.1.0: exceptions.Server414Error is deprecated in favour of exceptions.Client414Error

• 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.TimeStrippergroups 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

Pending removal in Pywikibot 10

• 9.6.0: Python 3.7 support is deprecated and will be dropped with Pywikibot 10
• 9.1.0: version.svn_rev_infoand version.getversion_svnwill be removed. SVN is no longer supported. (T362484)
• 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.3.0: Old color escape sequences like \03{color} is deprecated in favour of new color format like <>
• 7.3.0: linktrail method of family.Familyis deprecated; use APISite.linktrail() instead
• 7.2.0: Positional arguments decoder, layer and newline for loggingfunctions were dropped; keyword arguments must be used instead.
• 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.0.0: User.isBlocked() method is renamed to is_blocked for consistency
• 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'

Release history

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

Contributing

Our code is maintained on Wikimedia's Gerrit installation <https://gerrit.wikimedia.org/>, learn <https://www.mediawiki.org/wiki/Developer_account> how to get started.

Code of Conduct

The development of this software is covered by a Code of Conduct <https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct>_.