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.

Contents

• pywikibot package
  • Pywikibot Subpackages
    • comms package
      • Submodules
      • comms.eventstreams module
      • comms.http module
    • data package
      • Submodules
      • data.api module
      • data.memento module
      • data.mysql module
      • data.sparql module
      • data.wikistats module
    • families package
      • Submodules
      • families.commons_family module
      • families.foundation_family module
      • families.i18n_family module
      • families.incubator_family module
      • families.lingualibre_family module
      • families.mediawiki_family module
      • families.meta_family module
      • families.omegawiki_family module
      • families.osm_family module
      • families.outreach_family module
      • families.species_family module
      • families.vikidia_family module
      • families.wikibooks_family module
      • families.wikidata_family module
      • families.wikihow_family module
      • families.wikimania_family module
      • families.wikimediachapter_family module
      • families.wikinews_family module
      • families.wikipedia_family module
      • families.wikiquote_family module
      • families.wikisource_family module
      • families.wikisopore_family module
      • families.wikitech_family module
      • families.wikiversity_family module
      • families.wikivoyage_family module
      • families.wiktionary_family module
      • families.wowwiki_family module
    • page package
      • Submodules
      • page._collections module
      • page._decorators module
      • page._revision module
    • pagegenerators package
      • GENERATOR OPTIONS
      • FILTER OPTIONS
      • pagegenerators._factory module
      • pagegenerators._filters module
      • pagegenerators._generators module
    • site package
      • BaseSite package
      • APISite Package
      • DataSite Package
      • Obsolete Sites Package
      • Siteinfo Package
      • Namespace Package
      • TokenWallet Package
      • Uploader Package
    • specialbots package
    • tools package
      • tools.chars module
      • tools.collections module
      • tools.deprecate module
      • tools.djvu module
      • tools.formatter module
      • tools.itertools module
      • tools._logging module
    • userinterfaces package
      • _interface_base module
      • terminal_interface module
      • terminal_interface_base module
      • terminal_interface_unix module
      • terminal_interface_win32 module
      • buffer_interface module
      • gui module
      • transliteration module
      • win32_unicode module
  • Submodules
  • backports module
  • bot module
  • bot_choice module
  • config module
    • API reference
    • Option setting
      • Account Settings
      • User Interface Settings
      • External Editor Settings
      • Logfile Settings
      • External Script Path Settings
      • External Families Settings
      • Interwiki Settings
      • Solve Disambiguations Settings
      • Image Related Settings
      • Settings to Avoid Server Overload
      • Weblink Checker Settings
      • Database Settings
      • Http Settings
      • Cosmetic Changes Settings
      • Replication Bot Settings
      • Further Settings
  • cosmetic_changes module
  • daemonize module
  • date module
  • diff module
  • echo module
  • editor module
  • exceptions module
  • family module
  • fixes module
  • flow module
  • i18n module
  • interwiki_graph module
  • logentries module
  • logging module
  • login module
  • plural module
  • proofreadpage module
  • site_detect module
  • textlib module
  • throttle module
  • time module
  • titletranslate module
  • version module
  • xmlreader module
• comms package
  • Submodules
  • comms.eventstreams module
  • comms.http module
• config module
  • API reference
  • Option setting
    • Account Settings
    • User Interface Settings
    • External Editor Settings
    • Logfile Settings
    • External Script Path Settings
    • External Families Settings
    • Interwiki Settings
    • Solve Disambiguations Settings
    • Image Related Settings
    • Settings to Avoid Server Overload
    • Weblink Checker Settings
    • Database Settings
    • Http Settings
    • Cosmetic Changes Settings
    • Replication Bot Settings
    • Further Settings
• data package
  • Submodules
  • data.api module
  • data.memento module
  • data.mysql module
  • data.sparql module
  • data.wikistats module
• families package
  • Submodules
  • families.commons_family module
  • families.foundation_family module
  • families.i18n_family module
  • families.incubator_family module
  • families.lingualibre_family module
  • families.mediawiki_family module
  • families.meta_family module
  • families.omegawiki_family module
  • families.osm_family module
  • families.outreach_family module
  • families.species_family module
  • families.vikidia_family module
  • families.wikibooks_family module
  • families.wikidata_family module
  • families.wikihow_family module
  • families.wikimania_family module
  • families.wikimediachapter_family module
  • families.wikinews_family module
  • families.wikipedia_family module
  • families.wikiquote_family module
  • families.wikisource_family module
  • families.wikisopore_family module
  • families.wikitech_family module
  • families.wikiversity_family module
  • families.wikivoyage_family module
  • families.wiktionary_family module
  • families.wowwiki_family module
• page package
  • Submodules
  • page._collections module
  • page._decorators module
  • page._revision module
• pagegenerators package
  • GENERATOR OPTIONS
  • FILTER OPTIONS
  • pagegenerators._factory module
  • pagegenerators._filters module
  • pagegenerators._generators module
• site package
  • BaseSite package
  • APISite Package
  • DataSite Package
  • Obsolete Sites Package
  • Siteinfo Package
  • Namespace Package
  • TokenWallet Package
  • Uploader Package
• specialbots package
• tools package
  • tools.chars module
  • tools.collections module
  • tools.deprecate module
  • tools.djvu module
  • tools.formatter module
  • tools.itertools module
  • tools._logging module
• userinterfaces package
  • _interface_base module
  • terminal_interface module
  • terminal_interface_base module
  • terminal_interface_unix module
  • terminal_interface_win32 module
  • buffer_interface module
  • gui module
  • transliteration module
  • win32_unicode module