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 pywikibot.data.api. This layer then uses pywikibot.comms.http.request()
to do the actual HTTP request.
Contents¶
- pywikibot package
- Subpackages
- pywikibot.comms package
- pywikibot.data package
- pywikibot.families package
- Submodules
- pywikibot.families.commons_family module
- pywikibot.families.i18n_family module
- pywikibot.families.incubator_family module
- pywikibot.families.lyricwiki_family module
- pywikibot.families.mediawiki_family module
- pywikibot.families.meta_family module
- pywikibot.families.omegawiki_family module
- pywikibot.families.osm_family module
- pywikibot.families.outreach_family module
- pywikibot.families.species_family module
- pywikibot.families.strategy_family module
- pywikibot.families.test_family module
- pywikibot.families.vikidia_family module
- pywikibot.families.wikia_family module
- pywikibot.families.wikibooks_family module
- pywikibot.families.wikidata_family module
- pywikibot.families.wikimania_family module
- pywikibot.families.wikimediachapter_family module
- pywikibot.families.wikinews_family module
- pywikibot.families.wikipedia_family module
- pywikibot.families.wikiquote_family module
- pywikibot.families.wikisource_family module
- pywikibot.families.wikitech_family module
- pywikibot.families.wikiversity_family module
- pywikibot.families.wikivoyage_family module
- pywikibot.families.wiktionary_family module
- pywikibot.families.wowwiki_family module
- pywikibot.tools package
- pywikibot.userinterfaces package
- Submodules
- pywikibot.userinterfaces.cgi_interface module
- pywikibot.userinterfaces.gui module
- pywikibot.userinterfaces.terminal_interface module
- pywikibot.userinterfaces.terminal_interface_base module
- pywikibot.userinterfaces.terminal_interface_unix module
- pywikibot.userinterfaces.terminal_interface_win32 module
- pywikibot.userinterfaces.transliteration module
- pywikibot.userinterfaces.win32_unicode module
- Submodules
- pywikibot.bot module
- pywikibot.bot_choice module
- pywikibot.botirc module
- pywikibot.config2 module
- pywikibot.cosmetic_changes module
- pywikibot.daemonize module
- pywikibot.date module
- pywikibot.diff module
- pywikibot.echo module
- pywikibot.editor module
- pywikibot.exceptions module
- pywikibot.family module
- pywikibot.fixes module
- pywikibot.flow module
- pywikibot.i18n module
- pywikibot.interwiki_graph module
- pywikibot.logentries module
- pywikibot.logging module
- pywikibot.login module
- pywikibot.page module
- pywikibot.pagegenerators module
- pywikibot.plural module
- pywikibot.proofreadpage module
- pywikibot.site module
- pywikibot.site_detect module
- pywikibot.specialbots module
- pywikibot.textlib module
- pywikibot.throttle module
- pywikibot.titletranslate module
- pywikibot.version module
- pywikibot.weblib module
- pywikibot.xmlreader module
- Subpackages
- pywikibot.comms package
- pywikibot.compat package
- pywikibot.data package
- pywikibot.families package
- Submodules
- pywikibot.families.commons_family module
- pywikibot.families.i18n_family module
- pywikibot.families.incubator_family module
- pywikibot.families.lyricwiki_family module
- pywikibot.families.mediawiki_family module
- pywikibot.families.meta_family module
- pywikibot.families.omegawiki_family module
- pywikibot.families.osm_family module
- pywikibot.families.outreach_family module
- pywikibot.families.species_family module
- pywikibot.families.strategy_family module
- pywikibot.families.test_family module
- pywikibot.families.vikidia_family module
- pywikibot.families.wikia_family module
- pywikibot.families.wikibooks_family module
- pywikibot.families.wikidata_family module
- pywikibot.families.wikimania_family module
- pywikibot.families.wikimediachapter_family module
- pywikibot.families.wikinews_family module
- pywikibot.families.wikipedia_family module
- pywikibot.families.wikiquote_family module
- pywikibot.families.wikisource_family module
- pywikibot.families.wikitech_family module
- pywikibot.families.wikiversity_family module
- pywikibot.families.wikivoyage_family module
- pywikibot.families.wiktionary_family module
- pywikibot.families.wowwiki_family module
- pywikibot.tools package
- pywikibot.userinterfaces package
- Submodules
- pywikibot.userinterfaces.cgi_interface module
- pywikibot.userinterfaces.gui module
- pywikibot.userinterfaces.terminal_interface module
- pywikibot.userinterfaces.terminal_interface_base module
- pywikibot.userinterfaces.terminal_interface_unix module
- pywikibot.userinterfaces.terminal_interface_win32 module
- pywikibot.userinterfaces.transliteration module
- pywikibot.userinterfaces.win32_unicode module