API reference#
High-level request structure#
User code mainly interacts with pywikibot.Page
objects, which represent
pages on a specific wiki. These objects get their properties by calling functions
on their associated pywikibot.Site
object, which represents a specific
wiki.
The pywikibot.Site
object then calls the MediaWiki API using the
functions provided by data.api
. This layer then uses comms.http.request()
to do the actual HTTP request.
Table of contents#
pywikibot
— Base Classes and Functionsconfig
— Pywikibot Config Filepage
— MediaWiki Pagesproofreadpage
— ProofreadPage Extensionpagegenerators
— Page Generatorssite
— MediaWiki siteslogin
modulelogentries
modulefamily
— MediaWiki familiesfamilies
— Family Config Filesdata
— Data Exchangecomms
— Communication layerexceptions
— Exceptions and Warning Classestextlib
— Changing Wikitextcosmetic_changes
— Cosmetic Changes of Wikitextbot
— Classes for Building Botsspecialbots
— Special Reusable Botsbot_choice
— UI Options and Choicesuserinterfaces
— User interfaceslogging
— Logging Functionsdaemonize
— Daemonize Current Process (Unix only)date
— Date Classes and Functionstime
— Time Classes and Functionsdiff
— Helpers for computing deltasecho
— Echo Extension Classes and functionseditor
— Text editor classfixes
— standard fixes for replace.py scriptflow
— Structured Discussions Entitiesi18n
— i18n Supportplural
— i18n Plural rulesinterwiki_graph
— Graphviz Drawing for Interwikititletranslate
— Interwiki Title Translatorxmlreader
— XML Readersite_detect
— Classes for Detecting MediaWiki Sitesthrottle
— Slow Down Wiki I/Oversion
— Determine Pywikibot Versionbackports
— Python Backportstools
— Miscellaneous Helper Functionstools.chars
— Character Based Helper Functionstools.collections
— Container datatypestools.djvu
— DJVU files wrappertools.formatter
— Formatting Related Functions and Classestools.itertools
— Iterators for Efficient Loopingtools.threading
— Thread-based Classes