page — MediaWiki Pages

Interface of various types of MediaWiki pages.

class page.BaseLink(title, namespace=None, site=None)

Bases: ComparableMixin

A MediaWiki link (local or interwiki).

Has the following attributes:

• title: The title of the page linked to (str); does not include namespace or section

• namespace: The Namespace object of the page linked to

• site: The Site object for the wiki linked to

Parameters:

• title (str) – the title of the page linked to (str); does not include namespace or section

• namespace (int, pywikibot.Namespace or str) – the namespace of the page linked to. Can be provided as either an int, a Namespace instance or a str, defaults to the MAIN namespace.

• site (pywikibot.Site or str) – the Site object for the wiki linked to. Can be provided as either a Site instance or a db key, defaults to pywikibot.Site().

astext(onsite=None)

Return a text representation of the link.

Parameters:

onsite – if specified, present as a (possibly interwiki) link from the given site; otherwise, present as an internal link on the site.

Return type:

str

canonical_title()

Return full page title, including localized namespace.

classmethod fromPage(page)

Create a BaseLink to a Page.

Parameters:

page (pywikibot.page.Page) – target pywikibot.page.Page

Return type:

pywikibot.page.BaseLink

lookup_namespace()

Look up the namespace given the provided namespace id or name.

Return type:

pywikibot.Namespace

property namespace

Return the namespace of the link.

Return type:

pywikibot.Namespace

ns_title(onsite=None)

Return full page title, including namespace.

Parameters:

onsite – site object if specified, present title using onsite local namespace, otherwise use self canonical namespace.

Raises:

pywikibot.exceptions.InvalidTitleError – no corresponding namespace is found in onsite

property site

Return the site of the link.

Return type:

pywikibot.Site

class page.BasePage(source, title='', ns=0)

Bases: ComparableMixin

BasePage: Base object for a MediaWiki page.

This object only implements internally methods that do not require reading from or writing to the wiki. All other methods are delegated to the Site object.

Will be subclassed by Page, WikibasePage, and FlowPage.

Instantiate a Page object.

Three calling formats are supported:

• If the first argument is a Page, create a copy of that object. This can be used to convert an existing Page into a subclass object, such as Category or FilePage. (If the title is also given as the second argument, creates a copy with that title; this is used when pages are moved.)

• If the first argument is a Site, create a Page on that Site using the second argument as the title (may include a section), and the third as the namespace number. The namespace number is mandatory, even if the title includes the namespace prefix. This is the preferred syntax when using an already-normalized title obtained from api.php or a database dump. WARNING: may produce invalid objects if page title isn’t in normal form!

• If the first argument is a BaseLink, create a Page from that link. This is the preferred syntax when using a title scraped from wikitext, URLs, or another non-normalized source.

Parameters:

• source (pywikibot.page.BaseLink (or subclass), pywikibot.page.Page (or subclass), or pywikibot.page.Site) – the source of the page

• title (str) – normalized title of the page; required if source is a Site, ignored otherwise

• ns (int) – namespace number; required if source is a Site, ignored otherwise

applicable_protections()

Return the protection types allowed for that page.

If the page doesn’t exist it only returns “create”. Otherwise it returns all protection types provided by the site, except “create”. It also removes “upload” if that page is not in the File namespace.

It is possible, that it returns an empty set, but only if original protection types were removed.

Returns:

set of str

Return type:

set

autoFormat()

Return date.getAutoFormat dictName and value, if any.

Value can be a year, date, etc., and dictName is ‘YearBC’, ‘Year_December’, or another dictionary name. Please note that two entries may have exactly the same autoFormat, but be in two different namespaces, as some sites have categories with the same names. Regular titles return (None, None).

backlinks(follow_redirects=True, filter_redirects=None, namespaces=None, total=None, content=False)

Return an iterator for pages that link to this page.

Parameters:

• follow_redirects (bool) – if True, also iterate pages that link to a redirect pointing to the page.

• filter_redirects (Optional[bool]) – if True, only iterate redirects; if False, omit redirects; if None, do not filter

• namespaces – only iterate pages in these namespaces

• total (Optional[int]) – iterate no more than this number of pages in total

• content (bool) – if True, retrieve the content of the current version of each referring page (default False)

botMayEdit()

Determine whether the active bot is allowed to edit the page.

This will be True if the page doesn’t contain {{bots}} or {{nobots}} or any other template from edit_restricted_templates list in x_family.py file, or it contains them and the active bot is allowed to edit this page. (This method is only useful on those sites that recognize the bot-exclusion protocol; on other sites, it will always return True.)

The framework enforces this restriction by default. It is possible to override this by setting ignore_bot_templates=True in user cnfig file (user-config.py), or using page.put(force=True).

Return type:

bool

categories(with_sort_key=False, total=None, content=False)

Iterate categories that the article is in.

Parameters:

• with_sort_key (bool) – if True, include the sort key in each Category.

• total (Optional[int]) – iterate no more than this number of pages in total

• content (bool) – if True, retrieve the content of the current version of each category description page (default False)

Returns:

a generator that yields Category objects.

Return type:

generator

change_category(old_cat, new_cat, summary=None, sort_key=None, in_place=True, include=None, show_diff=False)

Remove page from oldCat and add it to newCat.

New in version 7.0: The show_diff parameter

Parameters:

• old_cat (pywikibot.page.Category) – category to be removed

• new_cat (pywikibot.page.Category or None) – category to be added, if any

• summary (Optional[str]) – string to use as an edit summary

• sort_key – sortKey to use for the added category. Unused if newCat is None, or if inPlace=True If sortKey=True, the sortKey used for oldCat will be used.

• in_place (bool) – if True, change categories in place rather than rearranging them.

• include (Optional[List[str]]) – list of tags not to be disabled by default in relevant textlib functions, where CategoryLinks can be searched.

• show_diff (bool) – show changes between oldtext and newtext (default: False)

Returns:

True if page was saved changed, otherwise False.

Return type:

bool

clear_cache()

Clear the cached attributes of the page.

Return type:

None

property content_model

Return the content model for this page.

If it cannot be reliably determined via the API, None is returned.

contributors(total=None, starttime=None, endtime=None)

Compile contributors of this page with edit counts.

Parameters:

• total (Optional[int]) – iterate no more than this number of revisions in total

• starttime – retrieve revisions starting at this Timestamp

• endtime – retrieve revisions ending at this Timestamp

Returns:

number of edits for each username

Return type:

collections.Counter

coordinates(primary_only=False)

Return a list of Coordinate objects for points on the page.

Uses the MediaWiki extension GeoData.

Parameters:

primary_only (bool) – Only return the coordinate indicated to be primary

Returns:

A list of Coordinate objects or a single Coordinate if primary_only is True

Return type:

list of Coordinate or Coordinate or None

create_short_link(permalink=False, with_protocol=True)

Return a shortened link that points to that page.

If shared_urlshortner_wiki is defined in family config, it’ll use that site to create the link instead of the current wiki.

Parameters:

• permalink (bool) – If true, the link will point to the actual revision of the page.

• with_protocol (bool) – If true, and if it’s not already included, the link will have http(s) protocol prepended. On Wikimedia wikis the protocol is already present.

Returns:

The reduced link.

Return type:

str

data_item()

Convenience function to get the Wikibase item of a page.

Return type:

pywikibot.page.ItemPage

property data_repository

Return the Site object for the data repository.

defaultsort(force=False)

Extract value of the {{DEFAULTSORT:}} magic word from the page.

Parameters:

force (bool) – force updating from the live site

Return type:

Optional[str]

delete(reason=None, prompt=True, mark=False, automatic_quit=False, *, deletetalk=False)

Delete the page from the wiki. Requires administrator status.

Changed in version 7.1: keyword only parameter deletetalk was added.

Parameters:

• reason (Optional[str]) – The edit summary for the deletion, or rationale for deletion if requesting. If None, ask for it.

• deletetalk (bool) – Also delete the talk page, if it exists.

• prompt (bool) – If true, prompt user for confirmation before deleting.

• mark (bool) – If true, and user does not have sysop rights, place a speedy-deletion request on the page instead. If false, non-sysops will be asked before marking pages for deletion.

• automatic_quit (bool) – show also the quit option, when asking for confirmation.

Returns:

the function returns an integer, with values as follows: value meaning 0 no action was done 1 page was deleted -1 page was marked for deletion

Return type:

int

property depth: int

Return the depth/subpage level of the page.

Check if the namespace allows subpages. Not allowed subpages means depth is always 0.

editTime()

Return timestamp of last revision to page.

Return type:

Timestamp

embeddedin(filter_redirects=None, namespaces=None, total=None, content=False)

Return an iterator for pages that embed this page as a template.

Parameters:

• filter_redirects (Optional[bool]) – if True, only iterate redirects; if False, omit redirects; if None, do not filter

• namespaces – only iterate pages in these namespaces

• total (Optional[int]) – iterate no more than this number of pages in total

• content (bool) – if True, retrieve the content of the current version of each embedding page (default False)

exists()

Return True if page exists on the wiki, even if it’s a redirect.

If the title includes a section, return False if this section isn’t found.

Return type:

bool

expand_text(force=False, includecomments=False)

Return the page text with all templates and parser words expanded.

Parameters:

• force (bool) – force updating from the live site

• includecomments (bool) – Also strip comments if includecomments parameter is not True.

Return type:

str

extlinks(total=None)

Iterate all external URLs (not interwiki links) from this page.

Parameters:

total (Optional[int]) – iterate no more than this number of pages in total

Returns:

a generator that yields str objects containing URLs.

Return type:

generator

extract(variant='plain', *, lines=None, chars=None, sentences=None, intro=True)

Retrieve an extract of this page.

New in version 7.1.

Parameters:

• variant (str) – The variant of extract, either ‘plain’ for plain text, ‘html’ for limited HTML (both excludes templates and any text formatting) or ‘wiki’ for bare wikitext which also includes any templates for example.

• lines (Optional[int]) – if not None, wrap the extract into lines with width of 79 chars and return a string with that given number of lines.

• chars (Optional[int]) – How many characters to return. Actual text returned might be slightly longer.

• sentences (Optional[int]) – How many sentences to return

• intro (bool) – Return only content before the first section

Raises:

• NoPageError – given page does not exist

• NotImplementedError – “wiki” variant does not support sencence parameter.

• ValueError – variant parameter must be “plain”, “html” or “wiki”

Return type:

str

See also

APISite.extract().

full_url()

Return the full URL.

get(force=False, get_redirect=False)

Return the wiki-text of the page.

This will retrieve the page from the server if it has not been retrieved yet, or if force is True. This can raise the following exceptions that should be caught by the calling code:

Raises:

• pywikibot.exceptions.NoPageError – The page does not exist

• pywikibot.exceptions.IsRedirectPageError – The page is a redirect. The argument of the exception is the title of the page it redirects to.

• pywikibot.exceptions.SectionError – The section does not exist on a page with a # link

Parameters:

• force (bool) – reload all page attributes, including errors.

• get_redirect (bool) – return the redirect text, do not follow the redirect, do not raise an exception.

Return type:

str

getCategoryRedirectTarget()

If this is a category redirect, return the target category title.

Return type:

Category

getDeletedRevision(timestamp, content=False, **kwargs)

Return a particular deleted revision by timestamp.

Returns:

a list of [date, editor, comment, text, restoration marker]. text will be None, unless content is True (or has been retrieved earlier). If timestamp is not found, returns empty list.

Parameters:

content (bool) –

Return type:

List

getOldVersion(oldid, force=False)

Return text of an old revision of this page.

Parameters:

• oldid – The revid of the revision desired.

• force (bool) –

Return type:

str

getRedirectTarget()

Return a Page object for the target this Page redirects to.

If this page is not a redirect page, will raise an IsNotRedirectPageError. This method also can raise a NoPageError.

Return type:

Page

getReferences(follow_redirects=True, with_template_inclusion=True, only_template_inclusion=False, filter_redirects=False, namespaces=None, total=None, content=False)

Return an iterator all pages that refer to or embed the page.

If you need a full list of referring pages, use pages = list(s.getReferences())

Parameters:

• follow_redirects (bool) – if True, also iterate pages that link to a redirect pointing to the page.

• with_template_inclusion (bool) – if True, also iterate pages where self is used as a template.

• only_template_inclusion (bool) – if True, only iterate pages where self is used as a template.

• filter_redirects (bool) – if True, only iterate redirects to self.

• namespaces – only iterate pages in these namespaces

• total (Optional[int]) – iterate no more than this number of pages in total

• content (bool) – if True, retrieve the content of the current version of each referring page (default False)

Return type:

Iterable[Page]

getVersionHistoryTable(reverse=False, total=None)

Return the version history as a wiki table.

Parameters:

• reverse (bool) –

• total (Optional[int]) –

get_parsed_page(force=False)

Retrieve parsed text (via action=parse) and cache it.

Changed in version 7.1: force parameter was added; _get_parsed_page becomes a public method

Parameters:

force (bool) – force updating from the live site

Return type:

str

See also

APISite.get_parsed_page()

has_content()

Page has been loaded.

Not existing pages are considered loaded.

New in version 7.6.

Return type:

bool

has_deleted_revisions()

Return True if the page has deleted revisions.

New in version 4.2.

Return type:

bool

has_permission(action='edit')

Determine whether the page can be modified.

Return True if the bot has the permission of needed restriction level for the given action type.

Parameters:

action (str) – a valid restriction type like ‘edit’, ‘move’

Raises:

ValueError – invalid action parameter

Return type:

bool

property image_repository

Return the Site object for the image repository.

imagelinks(total=None, content=False)

Iterate FilePage objects for images displayed on this Page.

Parameters:

• total (Optional[int]) – iterate no more than this number of pages in total

• content (bool) – if True, retrieve the content of the current version of each image description page (default False)

Returns:

a generator that yields FilePage objects.

interwiki(expand=True)

Iterate interwiki links in the page text, excluding language links.

Parameters:

expand (bool) – if True (default), include interwiki links found in templates transcluded onto this page; if False, only iterate interwiki links found in this page’s own wikitext

Returns:

a generator that yields Link objects

Return type:

generator

isAutoTitle()

Return True if title of this Page is in the autoFormat dict.

isCategoryRedirect()

Return True if this is a category redirect page, False otherwise.

Return type:

bool

isDisambig()

Return True if this is a disambiguation page, False otherwise.

By default, it uses the Disambiguator extension’s result. The identification relies on the presence of the __DISAMBIG__ magic word which may also be transcluded.

If the Disambiguator extension isn’t activated for the given site, the identification relies on the presence of specific templates. First load a list of template names from the Family file; if the value in the Family file is None or no entry was made, look for the list on [[MediaWiki:Disambiguationspage]]. If this page does not exist, take the MediaWiki message. ‘Template:Disambig’ is always assumed to be default, and will be appended regardless of its existence.

Return type:

bool

isIpEdit()

Return True if last editor was unregistered.

Return type:

bool

isRedirectPage()

Return True if this is a redirect, False if not or not existing.

isStaticRedirect(force=False)

Determine whether the page is a static redirect.

A static redirect must be a valid redirect, and contain the magic word __STATICREDIRECT__.

Changed in version 7.0: __STATICREDIRECT__ can be transcluded

Parameters:

force (bool) – Bypass local caching

Return type:

bool

isTalkPage()

Return True if this page is in any talk namespace.

is_categorypage()

Return True if the page is a Category, False otherwise.

is_filepage()

Return True if this is a file description page, False otherwise.

is_flow_page()

Whether a page is a Flow page.

Return type:

bool

iterlanglinks(total=None, include_obsolete=False)

Iterate all inter-language links on this page.

Parameters:

• total (Optional[int]) – iterate no more than this number of pages in total

• include_obsolete (bool) – if true, yield even Link object whose site is obsolete

Returns:

a generator that yields Link objects.

Return type:

generator

itertemplates(total=None, content=False)

Iterate Page objects for templates used on this Page.

Template parameters are ignored. This method only returns embedded templates, not template pages that happen to be referenced through a normal link.

Parameters:

• total (Optional[int]) – iterate no more than this number of pages in total

• content (bool) – if True, retrieve the content of the current version of each template (default False)

• content – bool

langlinks(include_obsolete=False)

Return a list of all inter-language Links on this page.

Parameters:

include_obsolete (bool) – if true, return even Link objects whose site is obsolete

Returns:

list of Link objects.

Return type:

list

lastNonBotUser()

Return name or IP address of last human/non-bot user to edit page.

Determine the most recent human editor out of the last revisions. If it was not able to retrieve a human user, returns None.

If the edit was done by a bot which is no longer flagged as ‘bot’, i.e. which is not returned by Site.botusers(), it will be returned as a non-bot edit.

Return type:

str

property latest_revision

Return the current revision for this page.

property latest_revision_id

Return the current revision id for this page.

linkedPages(*args, **kwargs)

Iterate Pages that this Page links to.

Only returns pages from “normal” internal links. Embedded templates are omitted but links within them are returned. All interwiki and external links are omitted.

For the parameters refer APISite.pagelinks

New in version 7.0: the follow_redirects keyword argument

Deprecated since version 7.0: the positional arguments

See also

API:Links

Keyword Arguments:

• namespaces – Only iterate pages in these namespaces (default: all)

• follow_redirects – if True, yields the target of any redirects, rather than the redirect page

• total – iterate no more than this number of pages in total

• content – if True, load the current content of each page

Return type:

Generator[Page, None, None]

loadDeletedRevisions(total=None, **kwargs)

Retrieve deleted revisions for this Page.

Stores all revisions’ timestamps, dates, editors and comments in self._deletedRevs attribute.

Returns:

iterator of timestamps (which can be used to retrieve revisions later on).

Return type:

generator

Parameters:

total (Optional[int]) –

markDeletedRevision(timestamp, undelete=True)

Mark the revision identified by timestamp for undeletion.

Parameters:

undelete (bool) – if False, mark the revision to remain deleted.

merge_history(dest, timestamp=None, reason=None)

Merge revisions from this page into another page.

See APISite.merge_history for details.

Parameters:

• dest (Page) – Destination page to which revisions will be merged

• timestamp (Timestamp) – Revisions from this page dating up to this timestamp will be merged into the destination page (if not given or False, all revisions will be merged)

• reason (str) – Optional reason for the history merge

Return type:

None

move(newtitle, reason=None, movetalk=True, noredirect=False, movesubpages=True)

Move this page to a new title.

Changed in version 7.2: The movesubpages parameter was added

Parameters:

• newtitle (str) – The new page title.

• reason (Optional[str]) – The edit summary for the move.

• movetalk (bool) – If true, move this page’s talk page (if it exists)

• noredirect (bool) – if move succeeds, delete the old page (usually requires sysop privileges, depending on wiki settings)

• movesubpages (bool) – Rename subpages, if applicable.

Return type:

None

moved_target()

Return a Page object for the target this Page was moved to.

If this page was not moved, it will raise a NoMoveTargetError. This method also works if the source was already deleted.

Return type:

pywikibot.page.Page

Raises:

pywikibot.exceptions.NoMoveTargetError – page was not moved

namespace()

Return the namespace of the page.

Returns:

namespace of the page

Return type:

Namespace

property oldest_revision

Return the first revision of this page.

Return type:

Revision

page_image()

Return the most appropriate image on the page.

Uses the MediaWiki extension PageImages.

Returns:

A FilePage object

Return type:

pywikibot.page.FilePage

property pageid: int

Return pageid of the page.

Returns:

pageid or 0 if page does not exist

permalink(oldid=None, percent_encoded=True, with_protocol=False)

Return the permalink URL of an old revision of this page.

Parameters:

• oldid – The revid of the revision desired.

• percent_encoded (bool) – if false, the link will be provided without title uncoded.

• with_protocol (bool) – if true, http or https prefixes will be included before the double slash.

Return type:

str

preloadText()

The text returned by EditFormPreloadText.

See API module “info”.

Application: on Wikisource wikis, text can be preloaded even if a page does not exist, if an Index page is present.

Return type:

str

properties(force=False)

Return the properties of the page.

Parameters:

force (bool) – force updating from the live site

Return type:

dict

protect(reason=None, protections=None, **kwargs)

Protect or unprotect a wiki page. Requires administrator status.

Valid protection levels are ‘’ (equivalent to ‘none’), ‘autoconfirmed’, ‘sysop’ and ‘all’. ‘all’ means ‘everyone is allowed’, i.e. that protection type will be unprotected.

In order to unprotect a type of permission, the protection level shall be either set to ‘all’ or ‘’ or skipped in the protections dictionary.

Expiry of protections can be set via kwargs, see Site.protect() for details. By default there is no expiry for the protection types.

Parameters:

• protections (Optional[dict]) – A dict mapping type of protection to protection level of that type. Allowed protection types for a page can be retrieved by Page.self.applicable_protections() Defaults to protections is None, which means unprotect all protection types. Example: {‘move’: ‘sysop’, ‘edit’: ‘autoconfirmed’}

• reason (Optional[str]) – Reason for the action, default is None and will set an empty string.

Return type:

None

protection()

Return a dictionary reflecting page protections.

Return type:

dict

purge(**kwargs)

Purge the server’s cache for this page.

Keyword Arguments:

• redirects – Automatically resolve redirects.

• converttitles – Convert titles to other variants if necessary. Only works if the wiki’s content language supports variant conversion.

• forcelinkupdate – Update the links tables.

• forcerecursivelinkupdate – Update the links table, and update the links tables for any page that uses this page as a template.

Return type:

bool

put(newtext, summary=None, watch=None, minor=True, botflag=None, force=False, asynchronous=False, callback=None, show_diff=False, **kwargs)

Save the page with the contents of the first argument as the text.

This method is maintained primarily for backwards-compatibility. For new code, using Page.save() is preferred. See save() method docs for all parameters not listed here.

New in version 7.0: The show_diff parameter

Parameters:

• newtext (str) – The complete text of the revised page.

• show_diff (bool) – show changes between oldtext and newtext (default: False)

• summary (Optional[str]) –

• watch (Optional[str]) –

• minor (bool) –

• botflag (Optional[bool]) –

• force (bool) –

• asynchronous (bool) –

Return type:

None

redirects(*, filter_fragments=None, namespaces=None, total=None, content=False)

Return an iterable of redirects to this page.

Parameters:

• filter_fragments (Optional[bool]) – If True, only return redirects with fragments. If False, only return redirects without fragments. If None, return both (no filtering).

• namespaces (Optional[Union[int, str, Namespace, Iterable[Union[int, str, Namespace]]]]) – only return redirects from these namespaces

• total (Optional[int]) – maximum number of redirects to retrieve in total

• content (bool) – load the current content of each redirect

Return type:

Iterable[Page]

New in version 7.0.

revision_count(contributors=None)

Determine number of edits from contributors.

Parameters:

contributors (iterable of str or User, a single pywikibot.User, a str or None) – contributor usernames

Returns:

number of edits for all provided usernames

Return type:

int

revisions(reverse=False, total=None, content=False, starttime=None, endtime=None)

Generator which loads the version history as Revision instances.

Parameters:

• reverse (bool) –

• total (Optional[int]) –

• content (bool) –

save(summary=None, watch=None, minor=True, botflag=None, force=False, asynchronous=False, callback=None, apply_cosmetic_changes=None, quiet=False, **kwargs)

Save the current contents of page’s text to the wiki.

Changed in version 7.0: boolean watch parameter is deprecated

Parameters:

• summary (Optional[str]) – The edit summary for the modification (optional, but most wikis strongly encourage its use)

• watch (Optional[str]) – Specify how the watchlist is affected by this edit, set to one of “watch”, “unwatch”, “preferences”, “nochange”: * watch: add the page to the watchlist * unwatch: remove the page from the watchlist * preferences: use the preference settings (Default) * nochange: don’t change the watchlist If None (default), follow bot account’s default settings

• minor (bool) – if True, mark this edit as minor

• botflag (Optional[bool]) – if True, mark this edit as made by a bot (default: True if user has bot status, False if not)

• force (bool) – if True, ignore botMayEdit() setting

• asynchronous (bool) – if True, launch a separate thread to save asynchronously

• callback – a callable object that will be called after the page put operation. This object must take two arguments: (1) a Page object, and (2) an exception instance, which will be None if the page was saved successfully. The callback is intended for use by bots that need to keep track of which saves were successful.

• apply_cosmetic_changes (Optional[bool]) – Overwrites the cosmetic_changes configuration value to this value unless it’s None.

• quiet (bool) – enable/disable successful save operation message; defaults to False. In asynchronous mode, if True, it is up to the calling bot to manage the output e.g. via callback.

section()

Return the name of the section this Page refers to.

The section is the part of the title following a ‘#’ character, if any. If no section is present, return None.

Return type:

Optional[str]

property site

Return the Site object for the wiki on which this Page resides.

Return type:

pywikibot.Site

templates(content=False)

Return a list of Page objects for templates used on this Page.

Template parameters are ignored. This method only returns embedded templates, not template pages that happen to be referenced through a normal link.

Parameters:

• content (bool) – if True, retrieve the content of the current version of each template (default False)

• content – bool

Return type:

List[Page]

property text: str

Return the current (edited) wikitext, loading it if necessary.

Returns:

text of the page

title(*, underscore=False, with_ns=True, with_section=True, as_url=False, as_link=False, allow_interwiki=True, force_interwiki=False, textlink=False, as_filename=False, insite=None, without_brackets=False)

Return the title of this Page, as a string.

Parameters:

• underscore (bool) – (not used with as_link) if true, replace all ‘ ‘ characters with ‘_’

• with_ns (bool) – if false, omit the namespace prefix. If this option is false and used together with as_link return a labeled link like [[link|label]]

• with_section (bool) – if false, omit the section

• as_url (bool) – (not used with as_link) if true, quote title as if in an URL

• as_link (bool) – if true, return the title in the form of a wikilink

• allow_interwiki (bool) – (only used if as_link is true) if true, format the link as an interwiki link if necessary

• force_interwiki (bool) – (only used if as_link is true) if true, always format the link as an interwiki link

• textlink (bool) – (only used if as_link is true) if true, place a ‘:’ before Category: and Image: links

• as_filename (bool) – (not used with as_link) if true, replace any characters that are unsafe in filenames

• insite – (only used if as_link is true) a site object where the title is to be shown. Default is the current family/lang given by -family and -lang or -site option i.e. config.family and config.mylang

• without_brackets (bool) – (cannot be used with as_link) if true, remove the last pair of brackets(usually removes disambiguation brackets).

Return type:

str

toggleTalkPage()

Return other member of the article-talk page pair for this Page.

If self is a talk page, returns the associated content page; otherwise, returns the associated talk page. The returned page need not actually exist on the wiki.

Returns:

Page or None if self is a special page.

Return type:

Optional[Page]

touch(callback=None, botflag=False, **kwargs)

Make a touch edit for this page.

See save() method docs for all parameters. The following parameters will be overridden by this method: - summary, watch, minor, force, asynchronous

Parameter botflag is False by default.

minor and botflag parameters are set to False which prevents hiding the edit when it becomes a real edit due to a bug.

Note

This discards content saved to self.text.

Parameters:

botflag (bool) –

undelete(reason=None)

Undelete revisions based on the markers set by previous calls.

If no calls have been made since loadDeletedRevisions(), everything will be restored.

Simplest case:

Page(...).undelete('This will restore all revisions')

More complex:

pg = Page(...)
revs = pg.loadDeletedRevisions()
for rev in revs:
    if ... #decide whether to undelete a revision
        pg.markDeletedRevision(rev) #mark for undeletion
pg.undelete('This will restore only selected revisions.')

Parameters:

reason (Optional[str]) – Reason for the action.

Return type:

None

userName()

Return name or IP address of last user to edit page.

Return type:

str

version()

Return MediaWiki version number of the page site.

This is needed to use @need_version() decorator for methods of Page objects.

watch(unwatch=False)

Add or remove this page to/from bot account’s watchlist.

Parameters:

unwatch (bool) – True to unwatch, False (default) to watch.

Returns:

True if successful, False otherwise.

Return type:

bool

class page.Category(source, title='', sort_key=None)

Bases: Page

A page in the Category: namespace.

All parameters are the same as for Page() Initializer.

Parameters:

title (str) –

articles(recurse=False, total=None, content=False, namespaces=None, sortby=None, reverse=False, starttime=None, endtime=None, startprefix=None, endprefix=None)

Yield all articles in the current category.

By default, yields all pages in the category that are not subcategories!

Parameters:

• recurse (int) – if not False or 0, also iterate articles in subcategories. If an int, limit recursion to this number of levels. (Example: recurse=1 will iterate articles in first-level subcats, but no deeper.)

• total (Optional[int]) – iterate no more than this number of pages in total (at all levels)

• namespaces (Optional[Union[int, List[int]]]) – only yield pages in the specified namespaces

• content (bool) – if True, retrieve the content of the current version of each page (default False)

• sortby (Optional[str]) – determines the order in which results are generated, valid values are “sortkey” (default, results ordered by category sort key) or “timestamp” (results ordered by time page was added to the category). This applies recursively.

• reverse (bool) – if True, generate results in reverse order (default False)

• starttime (Timestamp) – if provided, only generate pages added after this time; not valid unless sortby=”timestamp”

• endtime (Timestamp) – if provided, only generate pages added before this time; not valid unless sortby=”timestamp”

• startprefix (Optional[str]) – if provided, only generate pages >= this title lexically; not valid if sortby=”timestamp”

• endprefix (Optional[str]) – if provided, only generate pages < this title lexically; not valid if sortby=”timestamp”

Return type:

Iterable[Page]

aslink(sort_key=None)

Return a link to place a page in this Category.

Use this only to generate a “true” category link, not for interwikis or text links to category pages.

Parameters:

sort_key (Optional[str]) – The sort key for the article to be placed in this Category; if omitted, default sort key is used.

Return type:

str

property categoryinfo: dict

Return a dict containing information about the category.

The dict contains values for:

Numbers of pages, subcategories, files, and total contents.

isEmptyCategory()

Return True if category has no members (including subcategories).

Return type:

bool

isHiddenCategory()

Return True if the category is hidden.

Return type:

bool

members(recurse=False, namespaces=None, total=None, content=False)

Yield all category contents (subcats, pages, and files).

Return type:

Iterable[Page]

Parameters:

• recurse (bool) –

• total (Optional[int]) –

• content (bool) –

newest_pages(total=None)

Return pages in a category ordered by the creation date.

If two or more pages are created at the same time, the pages are returned in the order they were added to the category. The most recently added page is returned first.

It only allows to return the pages ordered from newest to oldest, as it is impossible to determine the oldest page in a category without checking all pages. But it is possible to check the category in order with the newly added first and it yields all pages which were created after the currently checked page was added (and thus there is no page created after any of the cached but added before the currently checked).

Parameters:

total (Optional[int]) – The total number of pages queried.

Returns:

A page generator of all pages in a category ordered by the creation date. From newest to oldest.

Note

It currently only returns Page instances and not a subclass of it if possible. This might change so don’t expect to only get Page instances.

Return type:

Generator[Page, None, None]

subcategories(recurse=False, total=None, content=False)

Iterate all subcategories of the current category.

Parameters:

• recurse (int) – if not False or 0, also iterate subcategories of subcategories. If an int, limit recursion to this number of levels. (Example: recurse=1 will iterate direct subcats and first-level sub-sub-cats, but no deeper.)

• total (Optional[int]) – iterate no more than this number of subcategories in total (at all levels)

• content (bool) – if True, retrieve the content of the current version of each category description page (default False)

class page.Claim(site, pid, snak=None, hash=None, is_reference=False, is_qualifier=False, rank='normal', **kwargs)

Bases: Property

A Claim on a Wikibase entity.

Claims are standard claims as well as references and qualifiers.

Defined by the “snak” value, supplemented by site + pid

Parameters:

• site (pywikibot.site.DataSite) – repository the claim is on

• pid – property id, with “P” prefix

• snak – snak identifier for claim

• hash – hash identifier for references

• is_reference (bool) – whether specified claim is a reference

• is_qualifier (bool) – whether specified claim is a qualifier

• rank (str) – rank for claim

SNAK_TYPES = ('value', 'somevalue', 'novalue')

TARGET_CONVERTER = {'commonsMedia': <function Claim.<lambda>>, 'geo-shape': <bound method _WbDataPage.fromWikibase of <class 'pywikibot.WbGeoShape'>>, 'globe-coordinate': <bound method Coordinate.fromWikibase of <class 'pywikibot.Coordinate'>>, 'monolingualtext': <function Claim.<lambda>>, 'quantity': <bound method WbQuantity.fromWikibase of <class 'pywikibot.WbQuantity'>>, 'tabular-data': <bound method _WbDataPage.fromWikibase of <class 'pywikibot.WbTabularData'>>, 'time': <bound method WbTime.fromWikibase of <class 'pywikibot.WbTime'>>, 'wikibase-form': <function Claim.<lambda>>, 'wikibase-item': <function Claim.<lambda>>, 'wikibase-lexeme': <function Claim.<lambda>>, 'wikibase-property': <function Claim.<lambda>>, 'wikibase-sense': <function Claim.<lambda>>}

addQualifier(qualifier, **kwargs)

Add the given qualifier.

Parameters:

qualifier (pywikibot.page.Claim) – the qualifier to add

addSource(claim, **kwargs)

Add the claim as a source.

Parameters:

claim (Claim) – the claim to add

Return type:

None

addSources(claims, **kwargs)

Add the claims as one source.

Parameters:

claims (list of Claim) – the claims to add

changeRank(rank, **kwargs)

Change the rank of the Claim and save.

changeSnakType(value=None, **kwargs)

Save the new snak value.

TODO: Is this function really needed?

Return type:

None

changeTarget(value=None, snaktype='value', **kwargs)

Set the target value in the data repository.

Parameters:

• value (object) – The new target value.

• snaktype (str) – The new snak type (‘value’, ‘somevalue’, or ‘novalue’).

Return type:

None

copy()

Create an independent copy of this object.

Return type:

pywikibot.page.Claim

classmethod fromJSON(site, data)

Create a claim object from JSON returned in the API call.

Parameters:

data (dict) – JSON containing claim data

Return type:

pywikibot.page.Claim

getRank()

Return the rank of the Claim.

getSnakType()

Return the type of snak.

Returns:

str (‘value’, ‘somevalue’ or ‘novalue’)

Return type:

str

getSources()

Return a list of sources, each being a list of Claims.

Return type:

list

getTarget()

Return the target value of this Claim.

None is returned if no target is set

Returns:

object

has_qualifier(qualifier_id, target)

Check whether Claim contains specified qualifier.

Parameters:

• qualifier_id (str) – id of the qualifier

• target – qualifier target to check presence of

Returns:

true if the qualifier was found, false otherwise

Return type:

bool

property on_item

Return item this claim is attached to.

classmethod qualifierFromJSON(site, data)

Create a Claim for a qualifier from JSON.

Qualifier objects are represented a bit differently like references, but I’m not sure if this even requires it’s own function.

Return type:

pywikibot.page.Claim

classmethod referenceFromJSON(site, data)

Create a dict of claims from reference JSON returned in the API call.

Reference objects are represented a bit differently, and require some more handling.

Return type:

dict

removeQualifier(qualifier, **kwargs)

Remove the qualifier. Call removeQualifiers().

Parameters:

qualifier (pywikibot.page.Claim) – the qualifier to remove

Return type:

None

removeQualifiers(qualifiers, **kwargs)

Remove the qualifiers.

Parameters:

qualifiers (list Claim) – the qualifiers to remove

Return type:

None

removeSource(source, **kwargs)

Remove the source. Call removeSources().

Parameters:

source (Claim) – the source to remove

Return type:

None

removeSources(sources, **kwargs)

Remove the sources.

Parameters:

sources (list of Claim) – the sources to remove

Return type:

None

same_as(other, ignore_rank=True, ignore_quals=False, ignore_refs=True)

Check if two claims are same.

Parameters:

• ignore_rank (bool) –

• ignore_quals (bool) –

• ignore_refs (bool) –

Return type:

bool

setRank(rank)

Set the rank of the Claim.

Return type:

None

setSnakType(value)

Set the type of snak.

Parameters:

value (str ('value', 'somevalue', or 'novalue')) – Type of snak

setTarget(value)

Set the target value in the local object.

Parameters:

value (object) – The new target value.

Raises:

ValueError – if value is not of the type required for the Claim type.

target_equals(value)

Check whether the Claim’s target is equal to specified value.

The function checks for:

• WikibaseEntity ID equality

• WbTime year equality

• Coordinate equality, regarding precision

• WbMonolingualText text equality

• direct equality

Parameters:

value – the value to compare with

Returns:

true if the Claim’s target is equal to the value provided, false otherwise

Return type:

bool

toJSON()

Create dict suitable for the MediaWiki API.

Return type:

dict

class page.FileInfo(file_revision)

Bases: object

A structure holding imageinfo of latest rev. of FilePage.

All keys of API imageinfo dictionary are mapped to FileInfo attributes. Attributes can be retrieved both as self[‘key’] or self.key.

Following attributes will be returned:

• timestamp, user, comment, url, size, sha1, mime, metadata

• archivename (not for latest revision)

see Site.loadimageinfo() for details.

Note

timestamp will be casted to pywikibot.Timestamp().

Changed in version 7.7: raises KeyError instead of AttributeError if FileInfo is used as Mapping.

Initiate the class using the dict from APISite.loadimageinfo.

class page.FilePage(source, title='')

Bases: Page

A subclass of Page representing a file description page.

Supports the same interface as Page, with some added methods.

Parameters:

title (str) –

data_item()

Convenience function to get the associated Wikibase item of the file.

If WikibaseMediaInfo extension is available (e.g. on Commons), the method returns the associated mediainfo entity. Otherwise, it falls back to behavior of BasePage.data_item.

New in version 6.5.

Return type:

pywikibot.page.WikibaseEntity

download(filename=None, chunk_size=102400, revision=None)

Download to filename file of FilePage.

Parameters:

• filename (None or str) – filename where to save file: None: self.title(as_filename=True, with_ns=False) will be used str: provided filename will be used.

• chunk_size (int) – the size of each chunk to be received and written to file.

• revision (None or FileInfo) – file revision to download: None: self.latest_file_info will be used FileInfo: provided revision will be used.

Returns:

True if download is successful, False otherwise.

Raises:

IOError – if filename cannot be written for any reason.

file_is_shared()

Check if the file is stored on any known shared repository.

Changed in version 7.0: return False if file does not exist on shared image repository instead raising NoPageError.

Return type:

bool

property file_is_used: bool

Check whether the file is used at this site.

New in version 7.1.

getFileVersionHistoryTable()

Return the version history in the form of a wiki table.

Return type:

str

getImagePageHtml()

Download the file page, and return the HTML, as a string.

Caches the HTML code, so that if you run this method twice on the same FilePage object, the page will only be downloaded once.

Return type:

str

get_file_history()

Return the file’s version history.

Returns:

dictionary with: key: timestamp of the entry value: instance of FileInfo()

Return type:

dict

get_file_url(url_width=None, url_height=None, url_param=None)

Return the url or the thumburl of the file described on this page.

Fetch the information if not available.

Once retrieved, thumburl information will also be accessible as latest_file_info attributes, named as in [1]: - url, thumburl, thumbwidth and thumbheight

Parameters correspond to iiprops in: [1] API:Imageinfo

Parameters validation and error handling left to the API call.

Parameters:

• url_width – see iiurlwidth in [1]

• url_height – see iiurlheigth in [1]

• url_param – see iiurlparam in [1]

Returns:

latest file url or thumburl

Return type:

str

globalusage(total=None)

Iterate all global usage for this page.

See also

using_pages()

Parameters:

total – iterate no more than this number of pages in total

Returns:

a generator that yields Pages also on sites different from self.site.

Return type:

generator

property latest_file_info

Retrieve and store information of latest Image rev. of FilePage.

At the same time, the whole history of Image is fetched and cached in self._file_revisions

Returns:

instance of FileInfo()

property oldest_file_info

Retrieve and store information of oldest Image rev. of FilePage.

At the same time, the whole history of Image is fetched and cached in self._file_revisions

Returns:

instance of FileInfo()

upload(source, **kwargs)

Upload this file to the wiki.

keyword arguments are from site.upload() method.

Parameters:

source (str) – Path or URL to the file to be uploaded.

Keyword Arguments:

• comment – Edit summary; if this is not provided, then filepage.text will be used. An empty summary is not permitted. This may also serve as the initial page text (see below).

• text – Initial page text; if this is not set, then filepage.text will be used, or comment.

• watch – If true, add filepage to the bot user’s watchlist

• ignore_warnings –

  It may be a static boolean, a callable returning a boolean or an iterable. The callable gets a list of UploadError instances and the iterable should contain the warning codes for which an equivalent callable would return True if all UploadError codes are in thet list. If the result is False it’ll not continue uploading the file and otherwise disable any warning and reattempt to upload the file.

  Note

  NOTE: If report_success is True or None it’ll raise an UploadError exception if the static boolean is False.

• chunk_size – The chunk size in bytesfor chunked uploading (see API:Upload#Chunked_uploading). It will only upload in chunks, if the chunk size is positive but lower than the file size.

• report_success – If the upload was successful it’ll print a success message and if ignore_warnings is set to False it’ll raise an UploadError if a warning occurred. If it’s None (default) it’ll be True if ignore_warnings is a bool and False otherwise. If it’s True or None ignore_warnings must be a bool.

Returns:

It returns True if the upload was successful and False otherwise.

Return type:

bool

usingPages(**kwargs)

Yield Pages on which the file is displayed.

Deprecated since version 7.4.0: Use using_pages() instead.

using_pages(**kwargs)

Yield Pages on which the file is displayed.

For parameters refer APISite.imageusage()

Usage example:

>>> site = pywikibot.Site('wikipedia:test')
>>> file = pywikibot.FilePage(site, 'Pywikibot MW gear icon.svg')
>>> used = list(file.using_pages(total=10))
>>> len(used)
1
>>> used[0].title()
'Pywikibot'

See also

globalusage()

Changed in version 7.2: all parameters from APISite.imageusage() are available.

Changed in version 7.4: renamed from usingPages().

class page.ItemPage(site, title=None, ns=None)

Bases: WikibasePage

Wikibase entity of type ‘item’.

A Wikibase item may be defined by either a ‘Q’ id (qid), or by a site & title.

If an item is defined by site & title, once an item’s qid has been looked up, the item is then defined by the qid.

Parameters:

• site (pywikibot.site.DataSite) – data repository

• title (str) – identifier of item, “Q###”, -1 or None for an empty item.

DATA_ATTRIBUTES: Dict[str, Any] = {'aliases': <class 'pywikibot.page._collections.AliasesDict'>, 'claims': <class 'pywikibot.page._collections.ClaimCollection'>, 'descriptions': <class 'pywikibot.page._collections.LanguageDict'>, 'labels': <class 'pywikibot.page._collections.LanguageDict'>, 'sitelinks': <class 'pywikibot.page._collections.SiteLinkCollection'>}

entity_type = 'item'

classmethod fromPage(page, lazy_load=False)

Get the ItemPage for a Page that links to it.

Parameters:

• page (pywikibot.page.Page) – Page to look for corresponding data item

• lazy_load (bool) – Do not raise NoPageError if either page or corresponding ItemPage does not exist.

Return type:

pywikibot.page.ItemPage

Raises:

• pywikibot.exceptions.NoPageError – There is no corresponding ItemPage for the page

• pywikibot.exceptions.WikiBaseError – The site of the page has no data repository.

classmethod from_entity_uri(site, uri, lazy_load=False)

Get the ItemPage from its entity uri.

Parameters:

• site (pywikibot.site.DataSite) – The Wikibase site for the item.

• uri (str) – Entity uri for the Wikibase item.

• lazy_load (bool) – Do not raise NoPageError if ItemPage does not exist.

Return type:

pywikibot.page.ItemPage

Raises:

• TypeError – Site is not a valid DataSite.

• ValueError – Site does not match the base of the provided uri.

• pywikibot.exceptions.NoPageError – Uri points to non-existent item.

get(force=False, get_redirect=False, *args, **kwargs)

Fetch all item data, and cache it.

Parameters:

• force (bool) – override caching

• get_redirect (bool) – return the item content, do not follow the redirect, do not raise an exception.

Raises:

• NotImplementedError – a value in args or kwargs

• IsRedirectPageError – instance is a redirect page and get_redirect is not True

Returns:

actual data which entity holds

Return type:

Dict[str, Any]

Note

dicts returned by this method are references to content of this entity and their modifying may indirectly cause unwanted change to the live content

getID(numeric=False, force=False)

Get the entity identifier.

Parameters:

• numeric (bool) – Strip the first letter and return an int

• force (bool) – Force an update of new data

getRedirectTarget()

Return the redirect target for this page.

getSitelink(site, force=False)

Return the title for the specific site.

If the item doesn’t have that language, raise NoPageError.

Parameters:

• site (pywikibot.Site or database name) – Site to find the linked page of.

• force (bool) – override caching

• get_redirect – return the item content, do not follow the redirect, do not raise an exception.

Raises:

• IsRedirectPageError – instance is a redirect page

• NoPageError – site is not in sitelinks

Return type:

str

isRedirectPage()

Return True if item is a redirect, False if not or not existing.

iterlinks(family=None)

Iterate through all the sitelinks.

Parameters:

family (str|pywikibot.family.Family) – string/Family object which represents what family of links to iterate

Returns:

iterator of pywikibot.Page objects

Return type:

iterator

mergeInto(item, **kwargs)

Merge the item into another item.

Parameters:

item (pywikibot.page.ItemPage) – The item to merge into

Return type:

None

removeSitelink(site, **kwargs)

Remove a sitelink.

A site can either be a Site object, or it can be a dbName.

Return type:

None

removeSitelinks(sites, **kwargs)

Remove sitelinks.

Sites should be a list, with values either being Site objects, or dbNames.

Return type:

None

setSitelink(sitelink, **kwargs)

Set sitelinks. Calls setSitelinks().

A sitelink can be a Page object, a BaseLink object or a {'site': dbname, 'title': title} dictionary.

Refer WikibasePage.editEntity() for asynchronous and callback usage.

Parameters:

sitelink (Union[BasePage, BaseLink, Dict[str, str]]) –

Return type:

None

setSitelinks(sitelinks, **kwargs)

Set sitelinks.

sitelinks should be a list. Each item in the list can either be a Page object, a BaseLink object, or a dict with key for ‘site’ and a value for ‘title’.

Refer editEntity() for asynchronous and callback usage.

Parameters:

sitelinks (List[Union[BasePage, BaseLink, Dict[str, str]]]) –

Return type:

None

set_redirect_target(target_page, create=False, force=False, keep_section=False, save=True, **kwargs)

Make the item redirect to another item.

You need to define an extra argument to make this work, like save=True

Parameters:

• target_page (pywikibot.page.ItemPage or string) – target of the redirect, this argument is required.

• force (bool) – if true, it sets the redirect target even the page is not redirect.

• create (bool) –

• keep_section (bool) –

• save (bool) –

title(**kwargs)

Return ID as title of the ItemPage.

If the ItemPage was lazy-loaded via ItemPage.fromPage, this method will fetch the Wikibase item ID for the page, potentially raising NoPageError with the page on the linked wiki if it does not exist, or does not have a corresponding Wikibase item ID.

This method also refreshes the title if the id property was set. i.e. item.id = ‘Q60’

All optional keyword parameters are passed to the superclass.

title_pattern = 'Q[1-9]\\d*'

class page.LexemeForm(repo, id_=None)

Bases: LexemeSubEntity

Wikibase lexeme form.

DATA_ATTRIBUTES: Dict[str, Any] = {'claims': <class 'pywikibot.page._collections.ClaimCollection'>, 'representations': <class 'pywikibot.page._collections.LanguageDict'>}

edit_elements(data, **kwargs)

Update form elements.

Parameters:

data (dict) – Data to be saved

Return type:

None

entity_type = 'form'

get(force=False)

Fetch all form data, and cache it.

Parameters:

force (bool) – override caching

Return type:

dict

Note

dicts returned by this method are references to content of this entity and their modifying may indirectly cause unwanted change to the live content

title_pattern = 'L[1-9]\\d*-F[1-9]\\d*'

toJSON(diffto=None)

Create dict suitable for the MediaWiki API.

Parameters:

diffto (Optional[dict]) –

Return type:

dict

class page.LexemePage(site, title=None)

Bases: WikibasePage

Wikibase entity of type ‘lexeme’.

Basic usage sample:

>>> import pywikibot
>>> repo = pywikibot.Site('wikidata')
>>> L2 = pywikibot.LexemePage(repo, 'L2')  # create a Lexeme page
>>> list(L2.claims.keys())  # access the claims
['P5831', 'P5402']
>>> len(L2.forms)  # access the forms
2
>>> F1 = L2.forms[0]  # access the first form
>>> list(F1.claims.keys())  # access its claims
['P898']
>>> len(L2.senses)  # access the senses
1
>>> S1 = L2.senses[0]  # access the first sense
>>> list(S1.claims.keys())  # and its claims
['P5137', 'P5972', 'P2888']

Parameters:

• site (pywikibot.site.DataSite) – data repository

• title (str or None) – identifier of lexeme, “L###”, -1 or None for an empty lexeme.

DATA_ATTRIBUTES: Dict[str, Any] = {'claims': <class 'pywikibot.page._collections.ClaimCollection'>, 'forms': <class 'pywikibot.page._wikibase.LexemeFormCollection'>, 'lemmas': <class 'pywikibot.page._collections.LanguageDict'>, 'senses': <class 'pywikibot.page._wikibase.LexemeSenseCollection'>}

add_form(form, **kwargs)

Add a form to the lexeme.

Parameters:

form (Form) – The form to add

Keyword Arguments:

• bot – Whether to flag as bot (if possible)

• asynchronous – if True, launch a separate thread to add form asynchronously

• callback – a callable object that will be called after the claim has been added. It must take two arguments: (1) a LexemePage object, and (2) an exception instance, which will be None if the entity was saved successfully. This is intended for use by bots that need to keep track of which saves were successful.

Return type:

None

entity_type = 'lexeme'

get(force=False, get_redirect=False, *args, **kwargs)

Fetch all lexeme data, and cache it.

Parameters:

• force (bool) – override caching

• get_redirect (bool) – return the lexeme content, do not follow the redirect, do not raise an exception.

Raises:

NotImplementedError – a value in args or kwargs

Note

dicts returned by this method are references to content of this entity and their modifying may indirectly cause unwanted change to the live content

get_data_for_new_entity()

Return data required for creation of a new lexeme.

isRedirectPage()

Return True if lexeme is redirect, False if not or not existing.

mergeInto(lexeme, **kwargs)

Merge the lexeme into another lexeme.

Parameters:

lexeme (LexemePage) – The lexeme to merge into

remove_form(form, **kwargs)

Remove a form from the lexeme.

Parameters:

form (LexemeForm) – The form to remove

Return type:

None

title_pattern = 'L[1-9]\\d*'

toJSON(diffto=None)

Create JSON suitable for Wikibase API.

When diffto is provided, JSON representing differences to the provided data is created.

Parameters:

diffto (Optional[dict]) – JSON containing entity data

Return type:

dict

class page.LexemeSense(repo, id_=None)

Bases: LexemeSubEntity

Wikibase lexeme sense.

DATA_ATTRIBUTES: Dict[str, Any] = {'claims': <class 'pywikibot.page._collections.ClaimCollection'>, 'glosses': <class 'pywikibot.page._collections.LanguageDict'>}

entity_type = 'sense'

title_pattern = 'L[1-9]\\d*-S[1-9]\\d*'

class page.Link(text, source=None, default_namespace=0)

Bases: BaseLink

A MediaWiki wikitext link (local or interwiki).

Constructs a Link object based on a wikitext link and a source site.

Extends BaseLink by the following attributes:

• section: The section of the page linked to (str or None); this contains any text following a ‘#’ character in the title

• anchor: The anchor text (str or None); this contains any text following a ‘|’ character inside the link

Parameters:

• text (str) – the link text (everything appearing between [[ and ]] on a wiki page)

• source (Site or BasePage) – the Site on which the link was found (not necessarily the site to which the link refers)

• default_namespace (int) – a namespace to use if the link does not contain one (defaults to 0)

Raises:

UnicodeError – text could not be converted to unicode.

property anchor: str

Return the anchor of the link.

astext(onsite=None)

Return a text representation of the link.

Parameters:

onsite – if specified, present as a (possibly interwiki) link from the given site; otherwise, present as an internal link on the source site.

classmethod create_separated(link, source, default_namespace=0, section=None, label=None)

Create a new instance but overwrite section or label.

The returned Link instance is already parsed.

Parameters:

• link (str) – The original link text.

• source (Site) – The source of the link.

• default_namespace (int) – The namespace this link uses when no namespace is defined in the link text.

• section (None or str) – The new section replacing the one in link. If None (default) it doesn’t replace it.

• label – The new label replacing the one in link. If None (default) it doesn’t replace it.

classmethod fromPage(page, source=None)

Create a Link to a Page.

Parameters:

• page (pywikibot.page.Page) – target Page

• source – Link from site source

• source – Site

Return type:

pywikibot.page.Link

illegal_titles_pattern = re.compile('[\\x00-\\x1f\\x23\\x3c\\x3e\\x5b\\x5d\\x7b\\x7c\\x7d\\x7f]|%[0-9A-Fa-f]{2}|&[A-Za-z0-9\x80-ÿ]+;|&#[0-9]+;|&#x[0-9A-Fa-f]+;')

classmethod langlinkUnsafe(lang, title, source)

Create a “lang:title” Link linked from source.

Assumes that the lang & title come clean, no checks are made.

Parameters:

• lang (str) – target site code (language)

• title (str) – target Page

• source – Link from site source

• source – Site

Return type:

pywikibot.page.Link

property namespace

Return the namespace of the link.

Return type:

pywikibot.Namespace

parse()

Parse wikitext of the link.

Called internally when accessing attributes.

parse_site()

Parse only enough text to determine which site the link points to.

This method does not parse anything after the first “:”; links with multiple interwiki prefixes (such as “wikt:fr:Parlais”) need to be re-parsed on the first linked wiki to get the actual site.

Returns:

The family name and site code for the linked site. If the site is not supported by the configured families it returns None instead of a str.

Return type:

tuple

property section: str

Return the section of the link.

property site

Return the site of the link.

Return type:

pywikibot.Site

property title: str

Return the title of the link.

class page.MediaInfo(repo, id_=None)

Bases: WikibaseEntity

Interface for MediaInfo entities on Commons.

New in version 6.5.

Parameters:

• repo (DataSite) – Entity repository.

• id (str or None, -1 and None mean non-existing) – Entity identifier.

DATA_ATTRIBUTES: Dict[str, Any] = {'labels': <class 'pywikibot.page._collections.LanguageDict'>}

property file: FilePage

Get the file associated with the mediainfo.

get(force=False)

Fetch all MediaInfo entity data and cache it.

Parameters:

force (bool) – override caching

Raises:

NoWikibaseEntityError – if this entity doesn’t exist

Returns:

actual data which entity holds

Return type:

dict

getID(numeric=False)

Get the entity identifier.

Parameters:

numeric (bool) – Strip the first letter and return an int

title_pattern = 'M[1-9]\\d*'

class page.Page(source, title='', ns=0)

Bases: BasePage, WikiBlameMixin

Page: A MediaWiki page.

Instantiate a Page object.

Parameters:

title (str) –

get_best_claim(prop)

Return the first best Claim for this page.

Return the first ‘preferred’ ranked Claim specified by Wikibase property or the first ‘normal’ one otherwise.

New in version 3.0.

Parameters:

prop (str) – property id, “P###”

Returns:

Claim object given by Wikibase property number for this page object.

Return type:

Claim or None

Raises:

UnknownExtensionError – site has no Wikibase extension

property raw_extracted_templates

Extract templates and parameters.

This method is using textlib.extract_templates_and_params(). Disabled parts and whitespace are stripped, except for whitespace in anonymous positional arguments.

Return type:

list of (str, OrderedDict)

set_redirect_target(target_page, create=False, force=False, keep_section=False, save=True, **kwargs)

Change the page’s text to point to the redirect page.

Parameters:

• target_page (Page or string) – target of the redirect, this argument is required.

• create (bool) – if true, it creates the redirect even if the page doesn’t exist.

• force (bool) – if true, it set the redirect target even the page doesn’t exist or it’s not redirect.

• keep_section (bool) – if the old redirect links to a section and the new one doesn’t it uses the old redirect’s section.

• save (bool) – if true, it saves the page immediately.

• kwargs – Arguments which are used for saving the page directly afterwards, like ‘summary’ for edit summary.

templatesWithParams()

Return templates used on this Page.

The templates are extracted by raw_extracted_templates(), with positional arguments placed first in order, and each named argument appearing as ‘name=value’.

All parameter keys and values for each template are stripped of whitespace.

Returns:

a list of tuples with one tuple for each template invocation in the page, with the template Page as the first entry and a list of parameters as the second entry.

Return type:

list of (pywikibot.page.Page, list)

class page.Property(site, id, datatype=None)

Bases: object

A Wikibase property.

While every Wikibase property has a Page on the data repository, this object is for when the property is used as part of another concept where the property is not _the_ Page of the property.

For example, a claim on an ItemPage has many property attributes, and so it subclasses this Property class, but a claim does not have Page like behaviour and semantics.

Parameters:

• site (pywikibot.site.DataSite) – data repository

• id (str) – id of the property

• datatype (Optional[str]) – datatype of the property; if not given, it will be queried via the API

getID(numeric=False)

Get the identifier of this property.

Parameters:

numeric (bool) – Strip the first letter and return an int

property type: str

Return the type of this property.

types = {'commonsMedia': <class 'pywikibot.page._filepage.FilePage'>, 'external-id': <class 'str'>, 'geo-shape': <class 'pywikibot.WbGeoShape'>, 'globe-coordinate': <class 'pywikibot.Coordinate'>, 'math': <class 'str'>, 'monolingualtext': <class 'pywikibot.WbMonolingualText'>, 'musical-notation': <class 'str'>, 'quantity': <class 'pywikibot.WbQuantity'>, 'string': <class 'str'>, 'tabular-data': <class 'pywikibot.WbTabularData'>, 'time': <class 'pywikibot.WbTime'>, 'url': <class 'str'>, 'wikibase-form': <class 'pywikibot.page._wikibase.LexemeForm'>, 'wikibase-item': <class 'pywikibot.page._wikibase.ItemPage'>, 'wikibase-lexeme': <class 'pywikibot.page._wikibase.LexemePage'>, 'wikibase-property': <class 'pywikibot.page._wikibase.PropertyPage'>, 'wikibase-sense': <class 'pywikibot.page._wikibase.LexemeSense'>}

value_types = {'commonsMedia': 'string', 'external-id': 'string', 'geo-shape': 'string', 'globe-coordinate': 'globecoordinate', 'math': 'string', 'musical-notation': 'string', 'tabular-data': 'string', 'url': 'string', 'wikibase-form': 'wikibase-entityid', 'wikibase-item': 'wikibase-entityid', 'wikibase-lexeme': 'wikibase-entityid', 'wikibase-property': 'wikibase-entityid', 'wikibase-sense': 'wikibase-entityid'}

class page.PropertyPage(source, title=None, datatype=None)

Bases: WikibasePage, Property

A Wikibase entity in the property namespace.

Should be created as:

PropertyPage(DataSite, 'P21')

or:

PropertyPage(DataSite, datatype='url')

Parameters:

• source (pywikibot.site.DataSite) – data repository property is on

• title (str) – identifier of property, like “P##”, “-1” or None for an empty property.

• datatype (str) – Datatype for a new property.

DATA_ATTRIBUTES: Dict[str, Any] = {'aliases': <class 'pywikibot.page._collections.AliasesDict'>, 'claims': <class 'pywikibot.page._collections.ClaimCollection'>, 'descriptions': <class 'pywikibot.page._collections.LanguageDict'>, 'labels': <class 'pywikibot.page._collections.LanguageDict'>}

entity_type = 'property'

get(force=False, *args, **kwargs)

Fetch the property entity, and cache it.

Parameters:

force (bool) – override caching

Raises:

NotImplementedError – a value in args or kwargs

Returns:

actual data which entity holds

Return type:

dict

Note

dicts returned by this method are references to content of this entity and their modifying may indirectly cause unwanted change to the live content

getID(numeric=False)

Get the identifier of this property.

Parameters:

numeric (bool) – Strip the first letter and return an int

get_data_for_new_entity()

Return data required for creation of new property.

newClaim(*args, **kwargs)

Helper function to create a new claim object for this property.

Return type:

Claim

title_pattern = 'P[1-9]\\d*'

class page.Revision(**kwargs)

Bases: Mapping

A structure holding information about a single revision of a Page.

Each data item can be accessed either by its key or as an attribute with the attribute name equal to the key e.g.:

>>> r = Revision(comment='Sample for Revision access')
>>> r.comment == r['comment']
True
>>> r.comment
'Sample for Revision access'

property content_model: str

DEPRECATED. Return content model of the revision.

This is meant for compatibility with older MW version which didn’t support revisions with slots. For newer MW versions, this returns the content model of the main slot.

Returns:

content model

property parent_id: int

DEPRECATED. Return id of parent/previous revision.

Returns 0 if there is no previous revision

Returns:

id of parent/previous revision

Raises:

AssertionError – parent id not supplied to the constructor

class page.SiteLink(title, site=None, badges=None)

Bases: BaseLink

A single sitelink in a Wikibase item.

Extends BaseLink by the following attribute:

• badges: Any badges associated with the sitelink

New in version 3.0.

Parameters:

• title (str) – the title of the linked page including namespace

• site (pywikibot.Site or str) – the Site object for the wiki linked to. Can be provided as either a Site instance or a db key, defaults to pywikibot.Site().

• badges ([ItemPage]) – list of badges

property badges

Return a list of all badges associated with the link.

Return type:

[ItemPage]

classmethod fromJSON(data, site=None)

Create a SiteLink object from JSON returned in the API call.

Parameters:

• data (dict) – JSON containing SiteLink data

• site (pywikibot.site.DataSite) – The Wikibase site

Return type:

pywikibot.page.SiteLink

toJSON()

Convert the SiteLink to a JSON object for the Wikibase API.

Returns:

Wikibase JSON

Return type:

dict

class page.User(source, title='')

Bases: Page

A class that represents a Wiki user.

This class also represents the Wiki page User:<username>

Initializer for a User object.

All parameters are the same as for Page() Initializer.

Parameters:

title (str) –

block(*args, **kwargs)

Block user.

Refer APISite.blockuser method for parameters.

Returns:

None

contributions(total=500, **kwargs)

Yield tuples describing this user edits.

Each tuple is composed of a pywikibot.Page object, the revision id (int), the edit timestamp (as a pywikibot.Timestamp object), and the comment (str). Pages returned are not guaranteed to be unique.

Parameters:

total (int) – limit result to this number of pages

Keyword Arguments:

• start – Iterate contributions starting at this Timestamp

• end – Iterate contributions ending at this Timestamp

• reverse – Iterate oldest contributions first (default: newest)

• namespaces – only iterate pages in these namespaces

• showMinor – if True, iterate only minor edits; if False and not None, iterate only non-minor edits (default: iterate both)

• top_only – if True, iterate only edits which are the latest revision (default: False)

Returns:

tuple of pywikibot.Page, revid, pywikibot.Timestamp, comment

Return type:

tuple

deleted_contributions(*, total=500, **kwargs)

Yield tuples describing this user’s deleted edits.

New in version 5.5.

Parameters:

total (int) – Limit results to this number of pages

Keyword Arguments:

• start – Iterate contributions starting at this Timestamp

• end – Iterate contributions ending at this Timestamp

• reverse – Iterate oldest contributions first (default: newest)

• namespaces – Only iterate pages in these namespaces

Return type:

Iterable[Tuple[Page, Revision]]

editCount(force=False)

Return edit count for a registered user.

Always returns 0 for ‘anonymous’ users.

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

int

property first_edit: Optional[Tuple[Page, int, Timestamp, str]]

Return first user contribution.

Returns:

first user contribution entry

Returns:

tuple of pywikibot.Page, revid, pywikibot.Timestamp, comment

gender(force=False)

Return the gender of the user.

Parameters:

force (bool) – if True, forces reloading the data from API

Returns:

return ‘male’, ‘female’, or ‘unknown’

Return type:

str

getUserPage(subpage='')

Return a Page object relative to this user’s main page.

Parameters:

subpage (str) – subpage part to be appended to the main page title (optional)

Returns:

Page object of user page or user subpage

Return type:

Page

getUserTalkPage(subpage='')

Return a Page object relative to this user’s main talk page.

Parameters:

subpage (str) – subpage part to be appended to the main talk page title (optional)

Returns:

Page object of user talk page or user talk subpage

Return type:

Page

getprops(force=False)

Return a properties about the user.

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

dict

groups(force=False)

Return a list of groups to which this user belongs.

The list of groups may be empty.

Parameters:

force (bool) – if True, forces reloading the data from API

Returns:

groups property

Return type:

list

isAnonymous()

Determine if the user is editing as an IP address.

Return type:

bool

isBlocked(force=False)

Determine whether the user is currently blocked.

Deprecated since version 7.0: use is_blocked() instead

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

bool

isEmailable(force=False)

Determine whether emails may be send to this user through MediaWiki.

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

bool

isRegistered(force=False)

Determine if the user is registered on the site.

It is possible to have a page named User:xyz and not have a corresponding user with username xyz.

The page does not need to exist for this method to return True.

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

bool

is_blocked(force=False)

Determine whether the user is currently blocked.

Changed in version 7.0: renamed from isBlocked() method, can also detect range blocks.

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

bool

is_locked(force=False)

Determine whether the user is currently locked globally.

New in version 7.0.

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

bool

property is_thankable: bool

Determine if the user has thanks notifications enabled.

Note

This doesn’t accurately determine if thanks is enabled for user. Privacy of thanks preferences is under discussion, please see T57401#2216861 and T120753#1863894.

property last_edit: Optional[Tuple[Page, int, Timestamp, str]]

Return last user contribution.

Returns:

last user contribution entry

Returns:

tuple of pywikibot.Page, revid, pywikibot.Timestamp, comment

property last_event

Return last user activity.

Returns:

last user log entry

Return type:

LogEntry or None

logevents(**kwargs)

Yield user activities.

Keyword Arguments:

• logtype – only iterate entries of this type (see mediawiki api documentation for available types)

• page – only iterate entries affecting this page

• namespace – namespace to retrieve logevents from

• start – only iterate entries from and after this Timestamp

• end – only iterate entries up to and through this Timestamp

• reverse – if True, iterate oldest entries first (default: newest)

• tag – only iterate entries tagged with this tag

• total – maximum number of events to iterate

Return type:

iterable

registration(force=False)

Fetch registration date for this user.

Parameters:

force (bool) – if True, forces reloading the data from API

Return type:

Optional[Timestamp]

rights(force=False)

Return user rights.

Parameters:

force (bool) – if True, forces reloading the data from API

Returns:

return user rights

Return type:

list

send_email(subject, text, ccme=False)

Send an email to this user via MediaWiki’s email interface.

Parameters:

• subject (str) – the subject header of the mail

• text (str) – mail body

• ccme (bool) – if True, sends a copy of this email to the bot

Raises:

• NotEmailableError – the user of this User is not emailable

• UserRightsError – logged in user does not have ‘sendemail’ right

Returns:

operation successful indicator

Return type:

bool

unblock(reason=None)

Remove the block for the user.

Parameters:

reason (Optional[str]) – Reason for the unblock.

Return type:

None

uploadedImages(total=10)

Yield tuples describing files uploaded by this user.

Each tuple is composed of a pywikibot.Page, the timestamp (str in ISO8601 format), comment (str) and a bool for pageid > 0. Pages returned are not guaranteed to be unique.

Parameters:

total (int) – limit result to this number of pages

property username: str

The username.

Convenience method that returns the title of the page with namespace prefix omitted, which is the username.

class page.WikibaseEntity(repo, id_=None)

Bases: object

The base interface for Wikibase entities.

Each entity is identified by a data repository it belongs to and an identifier.

Variables:

• DATA_ATTRIBUTES – dictionary which maps data attributes (eg. ‘labels’, ‘claims’) to appropriate collection classes (eg. LanguageDict, ClaimsCollection)

• entity_type – entity type identifier

• title_pattern – regular expression which matches all possible entity ids for this entity type

Parameters:

• repo (DataSite) – Entity repository.

• id (str or None, -1 and None mean non-existing) – Entity identifier.

DATA_ATTRIBUTES: Dict[str, Any] = {}

concept_uri()

Return the full concept URI.

Raises:

NoWikibaseEntityError – if this entity doesn’t exist

Return type:

str

editEntity(data=None, **kwargs)

Edit an entity using Wikibase wbeditentity API.

This function is wrapped around by:

• WikibasePage.editLabels()

• WikibasePage.editDescriptions()

• WikibasePage.editAliases()

• ItemPage.setSitelinks()

See also

WikibasePage.editEntity()

Parameters:

data (Optional[Union[Dict[Union[str, APISite], str], Dict[Union[str, APISite], List[str]], BasePage, BaseLink, Dict[str, str]]]) – Data to be saved

Return type:

None

exists()

Determine if an entity exists in the data repository.

Return type:

bool

get(force=False)

Fetch all entity data and cache it.

Parameters:

force (bool) – override caching

Raises:

NoWikibaseEntityError – if this entity doesn’t exist

Returns:

actual data which entity holds

Return type:

dict

getID(numeric=False)

Get the identifier of this entity.

Parameters:

numeric (bool) – Strip the first letter and return an int

get_data_for_new_entity()

Return data required for creation of a new entity.

Override it if you need.

Return type:

dict

classmethod is_valid_id(entity_id)

Whether the string can be a valid id of the entity type.

Parameters:

entity_id (str) – The ID to test.

Return type:

bool

property latest_revision_id: Optional[int]

Get the revision identifier for the most recent revision of the entity.

Return type:

int or None if it cannot be determined

Raises:

NoWikibaseEntityError – if the entity doesn’t exist

toJSON(diffto=None)

Create JSON suitable for Wikibase API.

When diffto is provided, JSON representing differences to the provided data is created.

Parameters:

diffto (Optional[dict]) – JSON containing entity data

Return type:

dict

class page.WikibasePage(site, title='', **kwargs)

Bases: BasePage, WikibaseEntity

Mixin base class for Wikibase entities which are also pages (eg. items).

There should be no need to instantiate this directly.

If title is provided, either ns or entity_type must also be provided, and will be checked against the title parsed using the Page initialisation logic.

Parameters:

• site (pywikibot.site.DataSite) – Wikibase data site

• title (str) – normalized title of the page

Keyword Arguments:

• ns – namespace

• entity_type – Wikibase entity type

Raises:

• TypeError – incorrect use of parameters

• ValueError – incorrect namespace

• pywikibot.exceptions.Error – title parsing problems

• NotImplementedError – the entity type is not supported

addClaim(claim, bot=True, **kwargs)

Add a claim to the entity.

Parameters:

• claim (pywikibot.page.Claim) – The claim to add

• bot (bool) – Whether to flag as bot (if possible)

Keyword Arguments:

• asynchronous – if True, launch a separate thread to add claim asynchronously

• callback – a callable object that will be called after the claim has been added. It must take two arguments: (1) a WikibasePage object, and (2) an exception instance, which will be None if the entity was saved successfully. This is intended for use by bots that need to keep track of which saves were successful.

Return type:

None

botMayEdit()

Return whether bots may edit this page.

Because there is currently no system to mark a page that it shouldn’t be edited by bots on Wikibase pages it always returns True. The content of the page is not text but a dict, the original way (to search for a template) doesn’t apply.

Returns:

True

Return type:

bool

editAliases(aliases, **kwargs)

Edit entity aliases.

aliases should be a dict, with the key as a language or a site object. The value should be a list of strings.

Refer editEntity() for asynchronous and callback usage.

Usage:

>>> repo = pywikibot.Site('wikidata:test')
>>> item = pywikibot.ItemPage(repo, 'Q68')
>>> item.editAliases({'en': ['pwb test item']})  

Parameters:

aliases (Dict[Union[str, APISite], List[str]]) –

Return type:

None

editDescriptions(descriptions, **kwargs)

Edit entity descriptions.

descriptions should be a dict, with the key as a language or a site object. The value should be the string to set it to. You can set it to '' to remove the description.

Refer editEntity() for asynchronous and callback usage.

Usage:

>>> repo = pywikibot.Site('wikidata:test')
>>> item = pywikibot.ItemPage(repo, 'Q68')
>>> item.editDescriptions({'en': 'Pywikibot test'})  

Parameters:

descriptions (Dict[Union[str, APISite], str]) –

Return type:

None

editEntity(data=None, **kwargs)

Edit an entity using Wikibase wbeditentity API.

This function is wrapped around by:

• editLabels()

• editDescriptions()

• editAliases()

• ItemPage.setSitelinks()

It supports asynchronous and callback keyword arguments. The callback function is intended for use by bots that need to keep track of which saves were successful. The minimal callback function signature is:

def my_callback(page: WikibasePage, err: Optional[Exception]) -> Any:

The arguments are:

page

a WikibasePage object

err

an Exception instance, which will be None if the page was saved successfully

See also

WikibaseEntity.editEntity()

Parameters:

• data (Optional[Union[Dict[Union[str, APISite], str], Dict[Union[str, APISite], List[str]], pywikibot.page.BasePage, pywikibot.page.BaseLink, Dict[str, str]]]) – Data to be saved

• kwargs (Any) –

Keyword Arguments:

• asynchronous (bool) – if True, launch a separate thread to edit asynchronously

• callback (Callable[[WikibasePage, Optional[Exception]], Any]) – a callable object that will be called after the entity has been updated. It must take two arguments, see above.

Return type:

None

editLabels(labels, **kwargs)

Edit entity labels.

labels should be a dict, with the key as a language or a site object. The value should be the string to set it to. You can set it to '' to remove the label.

Refer editEntity() for asynchronous and callback usage.

Usage:

>>> repo = pywikibot.Site('wikidata:test')
>>> item = pywikibot.ItemPage(repo, 'Q68')
>>> item.editLabels({'en': 'Test123'})  

Parameters:

labels (Dict[Union[str, APISite], str]) –

Return type:

None

exists()

Determine if an entity exists in the data repository.

Return type:

bool

get(force=False, *args, **kwargs)

Fetch all page data, and cache it.

Parameters:

force (bool) – override caching

Raises:

NotImplementedError – a value in args or kwargs

Returns:

actual data which entity holds

Return type:

dict

Note

dicts returned by this method are references to content of this entity and their modifying may indirectly cause unwanted change to the live content

property latest_revision_id: int

Get the revision identifier for the most recent revision of the entity.

Return type:

int

Raises:

pywikibot.exceptions.NoPageError – if the entity doesn’t exist

namespace()

Return the number of the namespace of the entity.

Returns:

Namespace id

Return type:

int

removeClaims(claims, **kwargs)

Remove the claims from the entity.

Parameters:

claims (list or Claim) – list of claims to be removed

Return type:

None

set_redirect_target(target_page, create=False, force=False, keep_section=False, save=True, **kwargs)

Set target of a redirect for a Wikibase page.

Has not been implemented in the Wikibase API yet, except for ItemPage.

Parameters:

• create (bool) –

• force (bool) –

• keep_section (bool) –

• save (bool) –

page.html2unicode(text, ignore=None, exceptions=None)

Replace HTML entities with equivalent unicode.

Parameters:

• ignore – HTML entities to ignore

• ignore – list of int

• text (str) –

Return type:

str

page.url2unicode(title, encodings='utf-8')

Convert URL-encoded text to unicode using several encoding.

Uses the first encoding that doesn’t cause an error.

Deprecated since version 6.2: Use tools.chars.url2string() instead.

Parameters:

• title (str) – URL-encoded character data to convert

• encodings (str, list or Site) – Encodings to attempt to use during conversion.

Raises:

UnicodeError – Could not convert using any encoding.

Return type:

str

Page Submodules

page._collections Wikibase Entity Structures

Structures holding data for Wikibase entities.

class pywikibot.page._collections.AliasesDict(data=None)

Bases: BaseDataDict

A structure holding aliases for a Wikibase entity.

It is a mapping from a language to a list of strings.

classmethod fromJSON(data, repo=None)

Construct a new AliasesDict from JSON.

classmethod normalizeData(data)

Helper function to expand data into the Wikibase API structure.

Changed in version 7.7: raises TypeError if data value is not a list.

Parameters:

data (dict) – Data to normalize

Returns:

The dict with normalized data

Raises:

TypeError – data values must be a list

Return type:

dict

toJSON(diffto=None)

Create JSON suitable for Wikibase API.

When diffto is provided, JSON representing differences to the provided data is created.

Parameters:

diffto (Optional[dict]) – JSON containing entity data

Return type:

dict

class pywikibot.page._collections.ClaimCollection(repo)

Bases: MutableMapping

A structure holding claims for a Wikibase entity.

classmethod fromJSON(data, repo)

Construct a new ClaimCollection from JSON.

classmethod new_empty(repo)

Construct a new empty ClaimCollection.

classmethod normalizeData(data)

Helper function to expand data into the Wikibase API structure.

Parameters:

data – Data to normalize

Returns:

The dict with normalized data

Return type:

dict

set_on_item(item)

Set Claim.on_item attribute for all claims in this collection.

Return type:

None

toJSON(diffto=None)

Create JSON suitable for Wikibase API.

When diffto is provided, JSON representing differences to the provided data is created.

Parameters:

diffto (Optional[dict]) – JSON containing entity data

Return type:

dict

class pywikibot.page._collections.LanguageDict(data=None)

Bases: BaseDataDict

A structure holding language data for a Wikibase entity.

Language data are mappings from a language to a string. It can be labels, descriptions and others.

classmethod fromJSON(data, repo=None)

Construct a new LanguageDict from JSON.

classmethod normalizeData(data)

Helper function to expand data into the Wikibase API structure.

Parameters:

data (dict) – Data to normalize

Returns:

The dict with normalized data

toJSON(diffto=None)

Create JSON suitable for Wikibase API.

When diffto is provided, JSON representing differences to the provided data is created.

Parameters:

diffto (Optional[dict]) – JSON containing entity data

Return type:

dict

class pywikibot.page._collections.SiteLinkCollection(repo, data=None)

Bases: MutableMapping

A structure holding SiteLinks for a Wikibase item.

Parameters:

repo (pywikibot.site.DataSite) – the Wikibase site on which badges are defined

classmethod fromJSON(data, repo)

Construct a new SiteLinkCollection from JSON.

static getdbName(site)

Helper function to obtain a dbName for a Site.

Parameters:

site (pywikibot.site.BaseSite or str) – The site to look up.

classmethod new_empty(repo)

Construct a new empty SiteLinkCollection.

classmethod normalizeData(data)

Helper function to expand data into the Wikibase API structure.

Parameters:

data (list or dict) – Data to normalize

Returns:

The dict with normalized data

Return type:

dict

toJSON(diffto=None)

Create JSON suitable for Wikibase API.

When diffto is provided, JSON representing differences to the provided data is created.

Parameters:

diffto (Optional[dict]) – JSON containing entity data

Return type:

dict

class pywikibot.page._collections.SubEntityCollection(repo, data=None)

Bases: MutableSequence

Ordered collection of sub-entities indexed by their ids.

Parameters:

• repo (pywikibot.site.DataSite) – Wikibase site

• data (iterable) – iterable of LexemeSubEntity

classmethod fromJSON(data, repo)

Construct a new SubEntityCollection from JSON.

insert(index, obj)

Insert a sub-entity to the collection.

classmethod new_empty(repo)

Construct a new empty SubEntityCollection.

classmethod normalizeData(data)

Helper function to expand data into the Wikibase API structure.

Parameters:

data (list) – Data to normalize

Returns:

the altered dict from parameter data.

Return type:

dict

toJSON(diffto=None)

Create JSON suitable for Wikibase API.

When diffto is provided, JSON representing differences to the provided data is created.

Parameters:

diffto (Optional[dict]) – JSON containing entity data

Return type:

dict

page._decorators — Page Decorators

Decorators for Page objects.

page._decorators._allow_asynchronous(func)

Decorator to make it possible to run a BasePage method asynchronously.

This is done when the method is called with kwarg asynchronous=True. Optionally, you can also provide kwarg callback, which, if provided, is a callable that gets the page as the first and a possible exception that occurred during saving in the second thread or None as the second argument.

page._decorators.allow_asynchronous(*outer_args, **outer_kwargs)

_allow_asynchronous decorated with tools.add_full_name()

page._revision — Page Revision

Object representing page revision.

class page._revision.Revision(**kwargs)

Bases: Mapping

A structure holding information about a single revision of a Page.

Each data item can be accessed either by its key or as an attribute with the attribute name equal to the key e.g.:

>>> r = Revision(comment='Sample for Revision access')
>>> r.comment == r['comment']
True
>>> r.comment
'Sample for Revision access'

property content_model: str

DEPRECATED. Return content model of the revision.

This is meant for compatibility with older MW version which didn’t support revisions with slots. For newer MW versions, this returns the content model of the main slot.

Returns:

content model

property parent_id: int

DEPRECATED. Return id of parent/previous revision.

Returns 0 if there is no previous revision

Returns:

id of parent/previous revision

Raises:

AssertionError – parent id not supplied to the constructor

page._toolforge module

Object representing interface to toolforge tools.

New in version 7.7.

class page._toolforge.WikiBlameMixin

Bases: object

Page mixin for main authorship.

New in version 7.7.

WIKIBLAME_CODES = ('als', 'bar', 'de', 'en', 'it', 'nds', 'sco')

Supported wikipedia site codes

main_authors(*, onlynew=None)

Retrieve the 5 topmost main authors of an article.

This method uses WikiHistory to retrieve the text based main authorship.

Sample:

>>> import pywikibot
>>> site = pywikibot.Site('wikipedia:nds')
>>> page = pywikibot.Page(site, 'Python (Programmeerspraak)')
>>> auth = page.main_authors(onlynew=False)
>>> auth
Counter({'RebeccaBreu': 99, 'Slomox': 1})

Note

Only implemented for main namespace pages.

Note

Only wikipedias of WIKIBLAME_CODES are supported.

See also

• https://wikihistory.toolforge.org

• https://de.wikipedia.org/wiki/Wikipedia:Technik/Cloud/wikihistory

Parameters:

onlynew (Optional[bool]) – If False, use the cached values. If True, calculate the Counter data which can take some time; it may fail with TimeoutError after config.max_retries. If None it calculates new data like for True but uses data from cache if new data cannot be calculated in meantime.

Returns:

Number of edits for each username

Raises:

• NotImplementedError – unsupported site or unsupported namespace

• pywikibot.exceptions.NoPageError – The page does not exist

• pywikibot.exceptions.TimeoutError – Maximum retries exceeded

Return type:

Counter