page — MediaWiki Pages - Pywikibot 11.3.0.dev0 documentation
Skip to content
Pywikibot 11.3.0.dev0 documentation
previous
next
modules
index
User guide
Introduction
Framework utility scripts
Scripts package
Global options
Frequently asked questions
Getting help
Pywikibot Security Policy
Bot developer guide
Using pywikibot as library
Recipes
API reference
MediaWiki API cross reference
Provide your own scripts
Pywikibot contributor guide
Framework utility scripts reference
Scripts reference
Installer scripts
Tests reference
Code of Conduct
About
Change log
Version compatibility
Licenses
Credits
Glossary
View this page
Edit this page
page
— MediaWiki Pages
Interface of various types of MediaWiki pages.
Imports in
pywikibot
module
The following classes and function are inported in
pywikibot
module
and can also be used as
pywikibot
members:
pywikibot.Category
pywikibot.Claim
pywikibot.FilePage
pywikibot.ItemPage
pywikibot.LexemeForm
pywikibot.LexemePage
pywikibot.LexemeSense
pywikibot.Link
pywikibot.Page
pywikibot.PropertyPage
pywikibot.SiteLink
pywikibot.User
pywikibot.html2unicode()
class
page.
BaseLink
title
namespace
None
site
None
[source]
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
str
or
None
) – 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
[source]
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
[source]
Return full page title, including localized namespace.
Return type
str
classmethod
fromPage
page
[source]
Create a BaseLink to a Page.
Parameters
page
pywikibot.page.Page
) – Target pywikibot.page.Page
Return type
pywikibot.page.BaseLink
lookup_namespace
[source]
Look up the namespace given the provided namespace id or name.
Return type
pywikibot.Namespace
property
namespace
[source]
Return the namespace of the link.
Return type
pywikibot.Namespace
ns_title
onsite
None
[source]
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
[source]
Return the site of the link.
Return type
pywikibot.Site
class
page.
BasePage
source
title
''
ns
[source]
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
pywikibot.Page
and
pywikibot.page.WikibasePage
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
[source]
Return the protection types allowed for that page.
Example:
>>>
site
pywikibot
Site
'wikipedia:test'
>>>
page
pywikibot
Page
site
'Main Page'
>>>
sorted
page
applicable_protections
())
['edit', 'move']
See also
protect()
protection()
Return type
set
str
autoFormat
[source]
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
[source]
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
bool
None
) – If True, only iterate redirects; if
False, omit redirects; if None, do not filter
namespaces
– Only iterate pages in these namespaces
total
int
None
) – 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
botMayEdit
[source]
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
[source]
Iterate categories that the article is in.
Changed in version 2.0:
with_sort_key
parameter is not supported and a
NotImplementedError is raised if set.
Changed in version 9.6:
with_sort_key
parameter is supported.
See also
Site.pagecategories()
Note
This method also yields categories which are
transcluded.
Parameters
with_sort_key
bool
) – If True, include the sort key in
each Category.
total
int
None
) – 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
Iterable
Page
change_category
old_cat
new_cat
summary
None
sort_key
None
in_place
True
include
None
show_diff
False
[source]
Remove page from oldCat and add it to newCat.
Added 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
str
None
) – String to use as an edit summary
sort_key
str
bool
None
) – Sort key to use for the added category. Unused
if
new_cat
is None, or if
in_place
is True. If
sort_key
is True, the sort Key used for
old_cat
will be used.
in_place
bool
) – If True, change categories in place rather than
rearranging them.
include
list
str
None
) – List of tags not to be disabled by default in
relevant
textlib
functions, where category links 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
[source]
Clear the cached attributes of the page.
Return type
None
property
content_model
[source]
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
[source]
Compile contributors of this page with edit counts.
Parameters
total
int
None
) – 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
[source]
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
[source]
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.
Raises
APIError
– urlshortener-ratelimit exceeded
Return type
str
data_item
[source]
Convenience function to get the Wikibase item of a page.
Return type
ItemPage
property
data_repository
[source]
Return the Site object for the data repository.
defaultsort
force
False
[source]
Extract value of the {{DEFAULTSORT:}} magic word from the page.
Parameters
force
bool
) – Force updating from the live site
Return type
str
None
delete
reason
None
prompt
True
mark
False
automatic_quit
False
deletetalk
False
[source]
Delete the page from the wiki. Requires administrator status.
Changed in version 7.1:
keyword only parameter
deletetalk
was added.
Changed in version 11.2:
deletetalk
option was implemented for MediaWiki < 1.38wmf24.
See also
undelete()
loadDeletedRevisions()
markDeletedRevision()
site.APISite.delete
Parameters
reason
str
None
) – The edit summary for the deletion, or rationale
for deletion if requesting. If None, ask for it.
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.
deletetalk
bool
) – Also delete the talk page, if it exists.
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
[source]
Return the depth/subpage level of the page.
Check if the namespace allows subpages. Not allowed subpages
means depth is always 0.
embeddedin
filter_redirects
None
namespaces
None
total
None
content
False
[source]
Return an iterator for pages that embed this page as a template.
Parameters
filter_redirects
bool
None
) – If True, only iterate redirects; if
False, omit redirects; if None, do not filter
namespaces
– Only iterate pages in these namespaces
total
int
None
) – 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)
Return type
Iterable
Page
exists
[source]
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
[source]
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
[source]
Iterate all external URLs (not interwiki links) from this page.
Parameters
total
int
None
) – Iterate no more than this number of pages in total
Returns
A generator that yields str objects containing URLs.
Return type
Iterable
str
extract
variant
'plain'
lines
None
chars
None
sentences
None
intro
True
[source]
Retrieve an extract of this page.
Added in version 7.1.
See also
APISite.extract()
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
int
None
) – If not None, wrap the extract into lines with
width of 79 chars and return a string with that given number
of lines.
chars
int
None
) – How many characters to return. Actual text
returned might be slightly longer.
sentences
int
None
) – 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
sentences
parameter.
ValueError
variant
parameter must be “plain”, “html” or
“wiki”.
Return type
str
full_url
[source]
Return the full URL.
get
force
False
get_redirect
False
[source]
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. Exceptions should be caught
by the calling code.
Example:
>>>
import
pywikibot
>>>
site
pywikibot
Site
'mediawiki'
>>>
page
pywikibot
Page
site
'Pywikibot'
>>>
page
get
get_redirect
True
'#REDIRECT[[Manual:Pywikibot]]'
>>>
page
get
()
Traceback (most recent call last):
...
pywikibot.exceptions.IsRedirectPageError
... is a redirect page.
Changed in version 9.2:
exceptions.SectionError
is raised if the
section()
does not exists
See also
text
property
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.
Raises
NoPageError
– The page does not exist.
IsRedirectPageError
– The page is a redirect.
SectionError
– The section does not exist on a page with
a # link.
Return type
str
getCategoryRedirectTarget
[source]
If this is a category redirect, return the target category title.
Return type
Category
getDeletedRevision
timestamp
content
False
**
kwargs
[source]
Return a particular deleted revision by timestamp.
Gives a dictionary with
revid
parentid
user
timestamp
and
comment
as keys like this:
'revid'
658621
'parentid'
'user'
'Pywikibot-test'
'timestamp'
'2025-05-24T11:01:25Z'
'comment'
'Pywikibot unit test'
If
content
is True, a
slots
key is added which holds
additional information of the content like:
'slots'
'main'
'contentmodel'
'wikitext'
'contentformat'
'text/x-wiki'
'*'
'Pywikibot deletion test.'
Caution
If
timestamp
is not found, an empty
list
is given.
See also
APISite.deletedrevs()
Parameters
timestamp
– Timestamp of the deleted revision
content
bool
) – If True, give also the content of the deleted
revision.
Returns
A dictionary information about the deleted revision. If
timestamp is not found, an empty list is given.
Return type
dict
str
Any
] |
list
NoReturn
getOldVersion
oldid
force
False
[source]
Return text of an old revision of this page.
Changed in version 10.0:
The unused parameter
get_redirect
was removed.
See also
get_revision()
Parameters
oldid
– The revid of the revision desired.
force
bool
Return type
str
getRedirectTarget
ignore_section
True
[source]
Return a Page object for the target this Page redirects to.
Added in version 9.3:
ignore_section
parameter
See also
Site.getredirtarget()
moved_target()
Parameters
ignore_section
bool
) – Do not include section to the target even
the link has one
Raises
CircularRedirectError
– Page is a circular redirect
InterwikiRedirectPageError
– The redirect target is on
another site
IsNotRedirectPageError
– Page is not a redirect
RuntimeError
– No redirects found
SectionError
– The section is not found on target page
and
ignore_section
is not set
Return type
Page
getReferences
follow_redirects
True
with_template_inclusion
True
only_template_inclusion
False
filter_redirects
False
namespaces
None
total
None
content
False
[source]
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
int
None
) – 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
[source]
Return the version history as a wiki table.
Parameters
reverse
bool
total
int
None
get_parsed_page
force
False
[source]
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
See also
APISite.get_parsed_page()
Parameters
force
bool
) – Force updating from the live site
Return type
str
get_revision
oldid
force
False
content
False
[source]
Return an old revision of this page.
Added in version 9.6.
See also
getOldVersion()
Parameters
oldid
int
) – The revid of the revision desired.
content
bool
) – If True, retrieve the content of the revision
(default False)
force
bool
Return type
Revision
has_content
[source]
Page has been loaded.
Not existing pages are considered loaded.
Added in version 7.6.
Return type
bool
has_deleted_revisions
[source]
Return True if the page has deleted revisions.
Added in version 4.2.
Return type
bool
has_permission
action
'edit'
[source]
Determine whether the page can be modified.
Return True if the bot has the permission of needed restriction level
for the given action type:
>>>
site
pywikibot
Site
'test'
>>>
page
pywikibot
Page
site
'Main Page'
>>>
page
has_permission
()
False
>>>
page
has_permission
'move'
False
>>>
page
has_permission
'invalid'
Traceback (most recent call last):
...
ValueError
APISite.page_can_be_edited(): Invalid value "invalid" ...
See also
APISite.page_can_be_edited()
Parameters
action
str
) – A valid restriction type like ‘edit’, ‘move’;
default is
edit
Raises
ValueError
– Invalid action parameter
Return type
bool
property
image_repository
[source]
Return the Site object for the image repository.
imagelinks
total
None
content
False
[source]
Iterate FilePage objects for images displayed on this Page.
Parameters
total
int
None
) – 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.
Return type
Iterable
FilePage
interwiki
expand
True
[source]
Yield 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
Link
isAutoTitle
[source]
Return True if title of this Page is in the autoFormat dict.
isCategoryRedirect
[source]
Return True if this is a category redirect page, False otherwise.
Return type
bool
isDisambig
[source]
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 via
BaseSite.disambig()
; if the value in
the Family file not found, 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
[source]
Deprecated; use latest_revision.anon instead.
Return True if last editor was unregistered.
Deprecated since version 9.3:
Use
latest_revision.anon
instead.
Return type
bool
isRedirectPage
[source]
Return True if this is a redirect, False if not or not existing.
isStaticRedirect
force
False
[source]
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
[source]
Return True if this page is in any talk namespace.
is_categorypage
[source]
Return True if the page is a Category, False otherwise.
is_filepage
[source]
Return True if this is a file description page, False otherwise.
is_flow_page
[source]
Whether a page is a Flow page.
Attention
Structured Discussion/Flow support was deprecated in 9.4 and
removed in Pywikibot 10. This method is kept to detect
unsupported content.
Return type
bool
iterlanglinks
total
None
include_obsolete
False
[source]
Iterate all inter-language links on this page.
Parameters
total
int
None
) – 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
Iterable
Link
itertemplates
total
None
content
False
namespaces
None
[source]
Iterate Page objects for templates used on this Page.
This method yield pages embedded as templates even they are not
in the TEMPLATE: namespace. The retrieved pages are not cached
but they can be yielded from the cache of a previous
templates()
call.
Added in version 2.0.
Changed in version 9.2:
namespaces
parameter was added; all parameters except
total
must be given as keyword arguments.
See also
site.APISite.pagetemplates()
templates()
getReferences()
Parameters
total
int
None
) – 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)
namespaces
int
str
Namespace
Iterable
int
str
Namespace
None
) – Only iterate pages in these namespaces
Return type
Iterable
Page
langlinks
include_obsolete
False
[source]
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
Link
lastNonBotUser
[source]
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
None
property
latest_revision
Revision
[source]
Return the current revision for this page.
Example:
>>>
site
pywikibot
Site
()
>>>
page
pywikibot
Page
site
'Main Page'
...
# get the latest timestamp of that page
>>>
edit_time
page
latest_revision
timestamp
>>>
type
edit_time
See also
oldest_revision
property
latest_revision_id
[source]
Return the current revision id for this page.
linkedPages
**
kwargs
[source]
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
Added in version 7.0:
the
follow_redirects
keyword argument.
Removed in version 10.0:
the positional arguments.
See also
Site.pagelinks
API:Links
Keyword Arguments
namespaces
– Only iterate pages in these namespaces
(default: all)
follow_redirects
bool
) – If True, yields the target of
any redirects, rather than the redirect page
total
int
) – Iterate no more than this number of pages in
total
content
bool
) – If True, load the current content of each
page
Return type
Generator
BasePage
loadDeletedRevisions
total
None
**
kwargs
[source]
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
int
None
markDeletedRevision
timestamp
undelete
True
[source]
Mark the revision identified by timestamp for undeletion.
See also
undelete()
loadDeletedRevisions()
Parameters
undelete
bool
) – If False, mark the revision to remain deleted.
Return type
None
merge_history
dest
timestamp
None
reason
None
[source]
Merge revisions from this page into another page.
See also
APISite.merge_history()
for details.
Parameters
dest
BasePage
) – Destination page to which revisions will be merged
timestamp
Timestamp
None
) – 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
None
) – Optional reason for the history merge
Return type
None
move
newtitle
reason
None
movetalk
True
noredirect
False
movesubpages
True
[source]
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
str
None
) – 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
Page
moved_target
[source]
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.
See also
getRedirectTarget()
Raises
NoMoveTargetError
– Page was not moved
Return type
Page
namespace
[source]
Return the namespace of the page.
Returns
Namespace of the page
Return type
Namespace
property
oldest_revision
Revision
[source]
Return the first revision of this page.
Example:
>>>
site
pywikibot
Site
()
>>>
page
pywikibot
Page
site
'Main Page'
...
# get the creation timestamp of that page
>>>
creation_time
page
oldest_revision
timestamp
>>>
type
creation_time
See also
latest_revision
page_image
[source]
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
[source]
Return pageid of the page.
Returns
Page id or 0 if page does not exist
permalink
oldid
None
percent_encoded
True
with_protocol
False
[source]
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
[source]
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
[source]
Return the properties of the page.
Parameters
force
bool
) – Force updating from the live site
Return type
dict
protect
reason
None
protections
None
**
kwargs
[source]
Protect or unprotect a wiki page. Requires
protect
right.
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.
See also
Site.protect()
applicable_protections()
Parameters
reason
str
None
) – Reason for the action, default is None and will
set an empty string.
protections
dict
str
str
None
None
) –
A dict mapping type of protection to
protection level of that type. Allowed protection types for
a page can be retrieved by
applicable_protections()
Defaults to protections is None, which means unprotect all
protection types.
Example:
{'move':
'sysop',
'edit':
'autoconfirmed'}
Return type
None
protection
[source]
Return a dictionary reflecting page protections.
Example:
>>>
site
pywikibot
Site
'wikipedia:test'
>>>
page
pywikibot
Page
site
'Main Page'
>>>
page
protection
()
{'edit': ('sysop', 'infinity'), 'move': ('sysop', 'infinity')}
See also
Site.page_restrictions()
applicable_protections()
protect()
Return type
dict
str
tuple
str
str
]]
purge
**
kwargs
[source]
Purge the server’s cache for this page.
Keyword Arguments
redirects
bool
) – Automatically resolve redirects.
converttitles
bool
) – Convert titles to other variants if
necessary. Only works if the wiki’s content language
supports variant conversion.
forcelinkupdate
bool
) – Update the links tables.
forcerecursivelinkupdate
bool
) – 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
bot
True
force
False
asynchronous
False
callback
None
show_diff
False
botflag
'[deprecated
name
of
bot]'
**
kwargs
[source]
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
save()
is preferred; also ee that
method docs for all parameters not listed here.
Added in version 7.0:
The
show_diff
parameter
Changed in version 9.3:
botflag
parameter was renamed to
bot
Changed in version 9.4:
edits cannot be marked as bot edits if the bot account has no
bot
right. Therefore a
None
argument for
bot
parameter was dropped.
See also
save()
Parameters
newtext
str
) – The complete text of the revised page.
show_diff
bool
) – Show changes between oldtext and newtext
(default: False)
summary
str
None
watch
str
None
minor
bool
bot
bool
force
bool
asynchronous
bool
redirects
filter_fragments
None
namespaces
None
total
None
content
False
[source]
Return an iterable of redirects to this page.
Added in version 7.0.
Parameters
filter_fragments
bool
None
) – If True, only return redirects with
fragments. If False, only return redirects without fragments.
If None, return both (no filtering).
namespaces
int
str
Namespace
Iterable
int
str
Namespace
None
) – Only return redirects from these namespaces
total
int
None
) – Maximum number of redirects to retrieve in total
content
bool
) – Load the current content of each redirect
Return type
Iterable
Page
revision_count
contributors
None
[source]
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
[source]
Generator which loads the version history as Revision instances.
Parameters
reverse
bool
total
int
None
content
bool
rollback
**
kwargs
[source]
Roll back this page to the version before the last edit by a user.
Added in version 10.5.
See also
Site.rollbackpage()
Keyword Arguments
tags
str
Sequence
str
None
) – Tags to apply to the rollback.
user
str
) – The last user to be rolled back; Default is
BasePage.latest_revision.user
summary
str
None
) – Custom edit summary for the rollback
markbot
bool
None
) – Mark the reverted edits and the
revert as bot edits. If not given, it is set to True if the
rollback user belongs to the ‘bot’ group, otherwise False.
watchlist
Literal
'watch'
'unwatch'
'preferences'
'nochange'
None
) – Unconditionally add or remove the page from
the current user’s watchlist; ‘preferences’ is ignored for
bot users.
watchlistexpiry
Timestamp
str
Literal
'infinite'
'indefinite'
'infinity'
'never'
None
) – Watchlist expiry timestamp. Omit this
parameter entirely to leave the current expiry unchanged.
Returns
Dictionary containing rollback result like
'title'
page
title
'pageid'
page
ID
'summary'
rollback
summary
'revid'
ID
of
the
new
revision
created
by
the
rollback
'old_revid'
ID
of
the
newest
revision
being
rolled
back
'last_revid'
ID
of
the
revision
restored
by
the
rollback
Parameters
kwargs
Any
Return type
dict
str
int
str
raises exceptions.Error: The rollback fails.
summary
None
watch
None
minor
True
bot
True
force
False
asynchronous
False
callback
None
apply_cosmetic_changes
None
quiet
False
botflag
'[deprecated
name
of
bot]'
**
kwargs
[source]
Save the current contents of page’s text to the wiki.
Changed in version 7.0:
boolean
watch
parameter is deprecated
Changed in version 9.3:
botflag
parameter was renamed to
bot
Changed in version 9.4:
edits cannot be marked as bot edits if the bot account has no
bot
right. Therefore a
None
argument for
bot
parameter was dropped.
Changed in version 10.0:
boolean
watch
parameter is desupported
Hint
Setting up
OAuth
or
BotPassword
login, you have to grant
High-volume
(bot)
access
to get
bot
right even if the
account is member of the bots group granted by bureaucrats.
Otherwise edits cannot be marked with both flag and
bot
argument will be ignored.
See also
APISite.editpage
Parameters
summary
str
None
) – The edit summary for the modification (optional,
but most wikis strongly encourage its use)
watch
str
None
) –
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
bot
bool
) – If True, mark this edit as made by a bot if user has
bot
right (default), if False do not mark it as bot edit.
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
bool
None
) – 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.
Raises
TypeError
– Watch parameter must be a string literal or
None
OtherPageSaveError
– Editing restricted by a template.
section
[source]
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
str
None
property
site
[source]
Return the Site object for the wiki on which this Page resides.
Return type
pywikibot.Site
templates
content
False
namespaces
None
[source]
Return a list of Page objects for templates used on this Page.
This method returns a list of pages which are embedded as
templates even they are not in the TEMPLATE: namespace. This
method caches the result. If
namespaces
is used, all pages are
retrieved and cached but the result is filtered.
Changed in version 2.0:
a list of
pywikibot.Page
is returned instead of a
list of template titles. The given pages may have namespaces
different from TEMPLATE namespace.
get_redirect
parameter
was removed.
Changed in version 9.2:
namespaces
parameter was added; all parameters must be given
as keyword arguments.
See also
itertemplates()
Parameters
content
bool
) – If True, retrieve the content of the current version
of each template (default False)
namespaces
int
str
Namespace
Iterable
int
str
Namespace
None
) – Only iterate pages in these namespaces
Return type
list
Page
property
text
str
[source]
Return the current (edited) wikitext, loading it if necessary.
This property should be preferred over
get()
. If the page
does not exist, an empty string will be returned. For a redirect
it returns the redirect page content and does not raise an
exceptions.IsRedirectPageError
exception.
Example:
>>>
import
pywikibot
>>>
site
pywikibot
Site
'mediawiki'
>>>
page
pywikibot
Page
site
'Pywikibot'
>>>
page
text
'#REDIRECT[[Manual:Pywikibot]]'
>>>
page
text
'PWB Framework'
>>>
page
text
'PWB Framework'
>>>
page
text
None
# reload from wiki
>>>
page
text
'#REDIRECT[[Manual:Pywikibot]]'
>>>
del
page
text
# other way to reload from wiki
To save the modified text
save()
is one possible method.
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
[source]
Return the title of this Page, as a string.
Parameters
underscore
bool
) – Not used with
as_link
, If true, replace all
spaces with underscores.
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/code given by
-family
and
-code
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
[source]
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
Page
None
touch
callback
None
bot
False
botflag
'[deprecated
name
of
bot]'
**
kwargs
[source]
Make a touch edit for this page.
See Meth:
method docs for all parameters. The following
parameters will be overridden by this method:
summary
watch
minor
force
asynchronous
Parameter
bot
is False by default.
minor
and
bot
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.
Changed in version 9.2:
botflag
parameter was renamed to
bot
Parameters
bot
bool
undelete
reason
None
[source]
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:
page
Page
...
revs
page
loadDeletedRevisions
()
for
rev
in
revs
if
...
# decide whether to undelete a revision
page
markDeletedRevision
rev
# mark for undeletion
page
undelete
'This will restore only selected revisions.'
See also
delete()
loadDeletedRevisions()
markDeletedRevision()
site.APISite.undelete
Parameters
reason
str
None
) – Reason for the action.
Return type
None
userName
[source]
Deprecated; use latest_revision.user instead.
Return name or IP address of last user to edit page.
Deprecated since version 9.3:
Use
latest_revision.user
instead.
Return type
str
version
[source]
Return MediaWiki version number of the page site.
This is needed to use @need_version() decorator for methods of
Page objects.
watch
unwatch
False
expiry
None
[source]
Add or remove this page from the bot account’s watchlist.
Changed in version 10.4.0:
Added the
expiry
parameter to specify watch expiry time.
Positional parameters are deprecated; all parameters must be
passed as keyword arguments.
See also
Site.watch()
Site.watched_pages()
API:Watch
Parameters
unwatch
bool
) – If True, the page will be from the watchlist.
expiry
Timestamp
str
Literal
'infinite'
'indefinite'
'infinity'
'never'
None
) – Expiry timestamp to apply to the watch. Passing
None or omitting this parameter leaves any existing expiry
unchanged. Expiry values may be relative (e.g.
months
or
weeks
) or absolute (e.g.
2014-09-18T12:34:56Z
).
For no expiry, use
infinite
indefinite
infinity
or
never
. For absolute timestamps the
Timestamp
class can be used.
Returns
True if successful, False otherwise.
Raises
APIError
– badexpiry: Invalid value for expiry parameter
KeyError
– ‘watch’ isn’t in API response
TypeError
– Unexpected keyword argument
Return type
bool
class
page.
Category
source
title
''
sort_key
None
[source]
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
**
kwargs
[source]
Yield all articles in the current category.
Yields all pages in the category that are not subcategories.
Duplicates are filtered. To enable duplicates use
members()
with
member_type=['page',
'file']
instead.
Usage:
>>>
site
pywikibot
Site
'wikipedia:test'
>>>
cat
pywikibot
Category
site
'Pywikibot'
>>>
list
cat
articles
())
[Page('Pywikibot nobots test')]
>>>
for
in
cat
articles
recurse
namespaces
total
):
...
depth
...
Warning
Categories may have infinite recursions of
subcategories. If
recurse
option is given as
True
or
an
int
value and this value is less than
sys.getrecursionlimit()
, an
RecursionError
may be
raised. Be careful if passing this generator to a collection
in such case.
Changed in version 8.0:
all parameters are keyword arguments only.
Parameters
recurse
int
bool
) – If not False or 0, also iterate articles in
subcategories. If an int, limit recursion to this number of
levels; e.g.
recurse=1
will iterate articles in
first-level subcats but no deeper.
total
int
None
) – Iterate no more than this number of pages in
total (at all levels)
kwargs
Any
) – Additional parameters. Refer to
APISite.categorymembers()
for complete list (
member_type
excluded).
Return type
Generator
Page
aslink
sort_key
None
[source]
Return a link to place a page in this Category.
Warning
Use this only to generate a “true” category link,
not for interwikis or text links to category pages.
Usage:
>>>
site
pywikibot
Site
'wikipedia:test'
>>>
cat
pywikibot
Category
site
'Foo'
>>>
cat
aslink
()
'[[Category:Foo]]'
>>>
cat
pywikibot
Category
site
'Foo'
sort_key
'bar'
>>>
cat
aslink
()
'[[Category:Foo|bar]]'
>>>
cat
aslink
'baz'
'[[Category:Foo|baz]]'
Parameters
sort_key
str
None
) – 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
str
Any
[source]
Return a dict containing information about the category.
The dict contains values for numbers of pages, subcategories,
files, and total contents.
See also
APISite.categoryinfo()
isEmptyCategory
[source]
Return True if category has no members (including subcategories).
Return type
bool
isHiddenCategory
[source]
Return True if the category is hidden.
Return type
bool
members
recurse
False
total
None
**
kwargs
[source]
Yield all category contents (subcats, pages, and files).
Usage:
>>>
site
pywikibot
Site
'wikipedia:test'
>>>
cat
pywikibot
Category
site
'Pywikibot'
>>>
list
cat
members
member_type
'subcat'
))
[Category('Category:Subpage testing')]
>>>
list
cat
members
member_type
'page'
'file'
]))
[Page('Pywikibot nobots test')]
Calling this method with
member_type='subcat'
is equal to
calling
subcategories()
. Calling this method with
member_type=['page',
'file']
is equal to calling
articles()
except that the later will filter duplicates.
See also
APISite.categorymembers()
Warning
Categories may have infinite recursions of
subcategories. If
recurse
option is given as
True
or
an
int
value and this value is less than
sys.getrecursionlimit()
, an
RecursionError
may be
raised. Be careful if passing this generator to a collection
in such case.
Changed in version 8.0:
all parameters are keyword arguments only. Additional
parameters are supported.
Parameters
recurse
int
bool
) – If not False or 0, also iterate articles in
subcategories. If an int, limit recursion to this number of
levels, e.g.
recurse=1
will iterate articles in
first-level subcats but no deeper.
total
int
None
) – Iterate no more than this number of pages in
total (at all levels)
kwargs
Any
) – Additional parameters. Refer to
APISite.categorymembers()
for complete list.
Return type
Generator
Page
newest_pages
total
None
[source]
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
int
None
) – 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
subcategories
recurse
False
**
kwargs
[source]
Yield all subcategories of the current category.
Usage:
>>>
site
pywikibot
Site
'wikipedia:en'
>>>
cat
pywikibot
Category
site
'Contents'
>>>
next
cat
subcategories
())
Category('Category:Wikipedia administration')
>>>
len
list
cat
subcategories
recurse
total
50
)))
50
Subcategories of the same level of each subtree are yielded
first before the next subcategories level are yielded. For example
having this category tree:
+-- B
| +-- E
| | +-- H
| +-- F
| +-- G
+-- C
| +-- I
| | +-- E
| | +-- H
| +-- J
| +-- K
| +-- L
| +-- G
+-- D
Subcategories are yields in the following order:
B, C, D, E, F, G, H, I, J, E, H, K, L, G
See also
categoryinfo
Warning
Categories may have infinite recursions of
subcategories. If
recurse
option is given as
True
or
an
int
value and this value is less than
sys.getrecursionlimit()
, an
RecursionError
may be
raised. Be careful if passing this generator to a collection
in such case.
Changed in version 8.0:
all parameters are keyword arguments only. Additional
parameters are supported. The order of subcategories are
yielded was changed. The old order was
B, E, H, F, G, C, I, E, H, J, K, L, G, D
Parameters
recurse
int
bool
) – If not False or 0, also iterate articles in
subcategories. If an int, limit recursion to this number of
levels, e.g.
recurse=1
will iterate articles in
first-level subcats but no deeper.
kwargs
Any
) – Additional parameters. Refer to
APISite.categorymembers()
for complete list (
member_type
excluded).
Return type
Generator
Category
class
page.
Claim
site
pid
snak
None
hash
None
is_reference
False
is_qualifier
False
rank
'normal'
**
kwargs
[source]
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 where the property of the claim is
defined. Note that this does not have to correspond to the
repository where the claim has been stored.
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':
'geo-shape':
WbDataPage.fromWikibase
of
'globe-coordinate':
Coordinate.fromWikibase
of
'monolingualtext':
'quantity':
WbQuantity.fromWikibase
of
'tabular-data':
WbDataPage.fromWikibase
of
'time':
WbTime.fromWikibase
of
'wikibase-form':
'wikibase-item':
'wikibase-lexeme':
'wikibase-property':
'wikibase-sense':
addQualifier
qualifier
**
kwargs
[source]
Add the given qualifier.
Parameters
qualifier
pywikibot.page.Claim
) – The qualifier to add
Return type
None
addSource
claim
**
kwargs
[source]
Add the claim as a source.
Parameters
claim
Pywikibot.Claim
) – The claim to add
Return type
None
addSources
claims
**
kwargs
[source]
Add the claims as one source.
Parameters
claims
List
of
Claim
) – The claims to add
Return type
None
changeRank
rank
**
kwargs
[source]
Change the rank of the Claim and save.
changeSnakType
value
None
**
kwargs
[source]
Save the new snak value.
TODO: Is this function really needed?
Return type
None
changeTarget
value
None
snaktype
'value'
**
kwargs
[source]
Set the target value in the data repository.
Parameters
value
Any
) – The new target value.
snaktype
Literal
'value'
'somevalue'
'novalue'
) – The new snak type (‘value’, ‘somevalue’, or
‘novalue’).
Return type
None
copy
[source]
Create an independent copy of this object.
Return type
pywikibot.page.Claim
classmethod
fromJSON
site
data
[source]
Create a claim object from JSON returned in the API call.
Changed in version 9.4:
print a warning if the Claim.type is not given and missing in
the wikibase.
Parameters
data
dict
str
Any
) – JSON containing claim data
Return type
Claim
getRank
[source]
Return the rank of the Claim.
getSnakType
[source]
Return the type of snak.
Return type
Literal
[‘value’ | ‘somevalue’ | ‘novalue’]
getSources
[source]
Return a list of sources, each being a list of Claims.
Return type
list
getTarget
[source]
Return the target value of this Claim.
None is returned if no target is set
Returns
Object
has_better_rank
other
[source]
Check if this claim has a better rank than the other claim.
Added in version 10.6.
Parameters
other
Claim
None
) – The other claim to compare with.
Returns
True if this claim has a better rank, False otherwise.
Return type
bool
has_qualifier
qualifier_id
target
[source]
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
WikibaseEntity
None
[source]
Return entity this claim is attached to.
classmethod
qualifierFromJSON
site
data
[source]
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
[source]
Create a dict of claims from reference JSON fetched in the API call.
Reference objects are represented a bit differently, and require
some more handling.
Return type
dict
removeQualifier
qualifier
**
kwargs
[source]
Remove the qualifier. Call removeQualifiers().
Parameters
qualifier
pywikibot.page.Claim
) – The qualifier to remove
Return type
None
removeQualifiers
qualifiers
**
kwargs
[source]
Remove the qualifiers.
Parameters
qualifiers
List
of
Claim
) – The qualifiers to remove
Return type
None
removeSource
source
**
kwargs
[source]
Remove the source. Call removeSources().
Parameters
source
Pywikibot.Claim
) – The source to remove
Return type
None
removeSources
sources
**
kwargs
[source]
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
[source]
Check if two claims are same.
Parameters
ignore_rank
bool
ignore_quals
bool
ignore_refs
bool
Return type
bool
setRank
rank
[source]
Set the rank of the Claim.
Return type
None
setSnakType
value
[source]
Set the type of snak.
Parameters
value
Literal
'value'
'somevalue'
'novalue'
) – Type of snak
Return type
None
setTarget
value
[source]
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.
Return type
None
target_equals
value
[source]
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
[source]
Create dict suitable for the MediaWiki API.
Return type
dict
class
page.
FileInfo
file_revision
filepage
[source]
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 (lazily)
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.
Changed in version 8.6:
Metadata are loaded lazily.
Added
filepage
parameter.
Initiate the class using the dict from
APISite.loadimageinfo
property
metadata
[source]
Return metadata.
Added in version 8.6.
update
file_revision
[source]
Update FileInfo with new values.
Added in version 8.6.
Return type
None
class
page.
FilePage
source
title
''
ignore_extension
False
[source]
Bases:
Page
A subclass of Page representing a file description page.
Supports the same interface as Page except
ns
; some added methods.
Changed in version 8.4:
Check for valid extensions.
Changed in version 9.3:
Added the optional
ignore_extension
parameter.
Changed in version 9.6:
Show a warning if
ignore_extension
was set and the
extension is invalid.
See also
Site.file_extensions
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
ignore_extension
bool
) – Prevent extension check
Raises
ValueError
– Either the title is not in the file
namespace or does not have a valid extension and
ignore_extension
was not set.
data_item
[source]
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 the behavior of
BasePage.data_item()
Added in version 6.5.
Return type
pywikibot.page.WikibaseEntity
filename
None
chunk_size
102400
revision
None
url_width
None
url_height
None
url_param
None
[source]
Download to filename file of FilePage.
Usage examples:
Download an image:
>>>
site
pywikibot
Site
'wikipedia:test'
>>>
file
pywikibot
FilePage
site
'Pywikibot MW gear icon.svg'
>>>
file
()
True
Pywikibot_MW_gear_icon.svg was downloaded.
Download a thumbnail:
>>>
file
url_param
'120px'
True
The suffix has changed and Pywikibot_MW_gear_icon.png was
downloaded.
Added in version 8.2:
url_width
url_height
and
url_param
parameters.
Changed in version 8.2:
filename
argument may be also a path-like object or an
iterable of path segments.
Changed in version 11.1:
Use a read throttle for download per Wikitech robot policy.
Set it to 25 times of
throttle.Throttle.delay
Note
filename suffix is adjusted if target url’s suffix is
different which may be the case if a thumbnail is loaded.
Warning
If a file already exists, it will be overridden
without further notes.
See also
API:Imageinfo
for new parameters
Parameters
filename
str
PathLike
Iterable
str
None
) – Filename where to save file. If
None
self.title(as_filename=True,
with_ns=False)
will be used.
If an Iterable is specified the items will be used as path
segments. To specify the user directory path you have to use
either
or
~user
as first path segment e.g.
~/foo
or
('~',
'foo')
as filename. If only the user directory
specifier is given, the title is used as filename like for
None. If the suffix is missing or different from url (which
can happen if a
url_width
url_height
or
url_param
argument is given), the file suffix is adjusted.
chunk_size
int
) – The size of each chunk to be received and
written to file.
revision
FileInfo
None
) – File revision to download. If None
latest_file_info
will be used; otherwise provided
revision will be used.
url_width
int
None
) – Download thumbnail with given width
url_height
int
None
) – Download thumbnail with given height
url_param
str
None
) – Download thumbnail with given param
Returns
True if download is successful, False otherwise.
Raises
IOError
– If filename cannot be written for any reason.
Return type
bool
file_is_shared
[source]
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
[source]
Check whether the file is used at this site.
Added in version 7.1.
getFileVersionHistoryTable
[source]
Return the version history in the form of a wiki table.
Return type
str
getImagePageHtml
[source]
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
[source]
Return the file’s version history.
Returns
Dictionary with:
key: timestamp of the entry
value: instance of FileInfo()
Return type
dict
get_file_info
ts
[source]
Retrieve and store information of a specific Image rev of FilePage.
This function will load also metadata. It is also used as a
helper in FileInfo to load metadata lazily.
Added in version 8.6.
Parameters
ts
– Timestamp of the Image revision to retrieve
Returns
Instance of FileInfo()
Return type
dict
get_file_url
url_width
None
url_height
None
url_param
None
[source]
Return the url or the thumburl of the file described on this page.
Fetch the information if not available.
Once retrieved, file information will also be accessible as
latest_file_info
attributes, named as in
API:Imageinfo
If
url_width
url_height
or
url_param
is given, additional
properties
thumbwidth
thumbheight
thumburl
and
responsiveUrls
are provided.
Note
Parameters validation and error handling left to the
API call.
Important
Starting with MediaWiki 1.45, the file width returned may be
greater than or equal to the requested
url_width
due to
T360589
. If you need the exact width, you must access
the corresponding thumbnail URL directly. See the additional
notes at
API:Imageinfo
Changed in version 11.2:
Remove UTM tracking parameter.
See also
APISite.loadimageinfo()
API:Imageinfo
Parameters
url_width
int
None
) – Get info for a thumbnail with given width
url_height
int
None
) – Get info for a thumbnail with given height
url_param
str
None
) – Get info for a thumbnail with given param
Returns
Latest file url or thumburl
Return type
str
globalusage
total
None
[source]
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
[source]
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
[source]
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
[source]
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 that 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
using_pages
**
kwargs
[source]
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
>>>
used
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
[source]
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
– Identifier of item, “Q###”; ‘-1’ or None for an
empty item.
ns
Namespace instance
, or
int
, or
None
) – Namespace, None for default site.item_namespace
DATA_ATTRIBUTES
dict
str
Any
{'aliases':
'claims':
'descriptions':
'labels':
'sitelinks':
entity_type
'item'
classmethod
fromPage
page
lazy_load
False
[source]
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
[source]
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
[source]
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
[source]
Get the entity identifier.
Parameters
numeric
bool
) – Strip the first letter and return an int
force
bool
) – Force an update of new data
getRedirectTarget
ignore_section
True
[source]
Return the redirect target for this page.
Added in version 9.3:
ignore_section
parameter
See also
page.BasePage.getRedirectTarget()
Parameters
ignore_section
bool
) – Do not include section to the target even
the link has one
Raises
CircularRedirectError
– Page is a circular redirect
InterwikiRedirectPageError
– The redirect target is on
another site
Error
– Target page has wrong content model
IsNotRedirectPageError
– Page is not a redirect
RuntimeError
– No redirects found
SectionError
– The section is not found on target page
and
ignore_section
is not set
getSitelink
site
force
False
[source]
Return the title for the specific site.
If the item doesn’t have a link to that site, raise
NoSiteLinkError.
Changed in version 8.1:
raises NoSiteLinkError instead of NoPageError.
Parameters
site
pywikibot.Site
or
database name
) – Site to find the linked page of.
force
bool
) – Override caching
Raises
IsRedirectPageError
– instance is a redirect page
NoSiteLinkError
– site is not in
sitelinks
Return type
str
get_best_claim
prop
[source]
Return the first best Claim for this page.
Return the first ‘preferred’ ranked Claim specified by Wikibase
property or the first ‘normal’ one otherwise.
Added in version 10.4.
See also
pywikibot.Page.get_best_claim()
Parameters
prop
str
) – Wikibase property ID, must be of the form
followed by one or more digits (e.g.
P31
).
Returns
Claim object given by Wikibase property number
for this page object.
Raises
UnknownExtensionError
– Site has no Wikibase extension
Return type
Claim
None
get_value_at_timestamp
prop
timestamp
lang
'en'
[source]
Return the best value for this page at a given timestamp.
Added in version 10.4.
Parameters
prop
str
) – Property id, “P###”
timestamp
WbTime
) – The timestamp to check the value at
lang
str
) – The language to return the value in
Returns
pywikibot.WbRepresentation
object given by
Wikibase property number for this page object and valid for
the given timestamp and language.
Raises
NoWikibaseEntityError
– Site has no time interval properties
Return type
pywikibot.WbRepresentation |
None
isRedirectPage
[source]
Return True if item is a redirect, False if not or not existing.
iterlinks
family
None
[source]
Iterate through all the sitelinks.
Parameters
family
str
pywikibot.family.Family
None
) – String/Family object which represents what family
of links to iterate
Returns
Iterator of pywikibot.Page objects
Return type
iterator
mergeInto
item
**
kwargs
[source]
Merge the item into another item.
Parameters
item
pywikibot.page.ItemPage
) – The item to merge into
Return type
None
removeSitelink
site
**
kwargs
[source]
Remove a sitelink.
A site can either be a Site object, or it can be a dbName.
Parameters
site
LANGUAGE_IDENTIFIER
Return type
None
removeSitelinks
sites
**
kwargs
[source]
Remove sitelinks.
Sites should be a list, with values either being Site objects,
or dbNames.
Parameters
sites
list
LANGUAGE_IDENTIFIER
Return type
None
setSitelink
sitelink
**
kwargs
[source]
Set sitelinks. Calls
setSitelinks()
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
SITELINK_TYPE
Return type
None
setSitelinks
sitelinks
**
kwargs
[source]
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
SITELINK_TYPE
Return type
None
set_redirect_target
target_page
create
False
force
False
keep_section
False
True
botflag
'[deprecated
name
of
bot]'
**
kwargs
[source]
Make the item redirect to another item.
You need to define an extra argument to make this work, like
save=True
Changed in version 9.3:
botflag
keyword parameter was renamed to
bot
Parameters
target_page
ItemPage
str
) – 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
bool
title
**
kwargs
[source]
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
[source]
Bases:
LexemeSubEntity
Wikibase lexeme form.
DATA_ATTRIBUTES
dict
str
Any
{'claims':
'representations':
edit_elements
data
**
kwargs
[source]
Update form elements.
Parameters
data
dict
) – Data to be saved
Return type
None
entity_type
'form'
get
force
False
[source]
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
[source]
Create dict suitable for the MediaWiki API.
Parameters
diffto
dict
None
Return type
dict
class
page.
LexemePage
site
title
None
[source]
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
# access the claims
['P5402', 'P5831', 'P12690', 'P12448', 'P31', 'P5275', 'P12510', ...]
>>>
len
L2
forms
# access the forms
>>>
F1
L2
forms
# access the first form
>>>
list
F1
claims
# access its claims
['P898']
>>>
len
L2
senses
# access the senses
>>>
S1
L2
senses
# access the first sense
>>>
list
S1
claims
# and its claims
['P5137', 'P5972', 'P2888']
Parameters
site
Pywikibot.site.DataSite
) – Data repository
title
str
None
) – Identifier of lexeme, “L###”; ‘-1’ or None for an
empty lexeme.
DATA_ATTRIBUTES
dict
str
Any
{'claims':
'forms':
'lemmas':
'senses':
add_form
form
**
kwargs
[source]
Add a form to the lexeme.
Parameters
form
Form
) – The form to add
Keyword Arguments
bot
bool
) – Whether to flag as bot (if possible)
asynchronous
bool
) – If True, launch a separate thread to
add form asynchronously
callback
Callable
) – 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
[source]
Fetch all lexeme data, and cache it.
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
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
get_data_for_new_entity
[source]
Return data required for creation of a new lexeme.
Return type
NoReturn
isRedirectPage
[source]
Return True if lexeme is redirect, False if not or not existing.
mergeInto
lexeme
**
kwargs
[source]
Merge the lexeme into another lexeme.
Parameters
lexeme
LexemePage
) – The lexeme to merge into
Return type
None
remove_form
form
**
kwargs
[source]
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
[source]
Create JSON suitable for Wikibase API.
When diffto is provided, JSON representing differences to the
provided data is created.
Parameters
diffto
dict
None
) – JSON containing entity data
Return type
dict
class
page.
LexemeSense
repo
id_
None
[source]
Bases:
LexemeSubEntity
Wikibase lexeme sense.
DATA_ATTRIBUTES
dict
str
Any
{'claims':
'glosses':
entity_type
'sense'
title_pattern
'L[1-9]\\d*-S[1-9]\\d*'
class
page.
Link
text
source
None
default_namespace
[source]
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
[source]
Return the anchor of the link.
astext
onsite
None
[source]
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
section
None
label
None
[source]
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
str
None
) – The new section replacing the one in link. If
None (default) it doesn’t replace it.
label
str
None
) – The new label replacing the one in link. If None
(default) it doesn’t replace it.
Return type
Link
classmethod
fromPage
page
source
None
[source]
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
[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
Site
) – Link from site source
Return type
pywikibot.page.Link
property
namespace
[source]
Return the namespace of the link.
Return type
pywikibot.Namespace
parse
[source]
Parse wikitext of the link.
Called internally when accessing attributes.
Return type
None
parse_site
[source]
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
[source]
Return the section of the link.
property
site
[source]
Return the site of the link.
Return type
pywikibot.Site
property
title
str
[source]
Return the title of the link.
class
page.
MediaInfo
repo
id_
None
[source]
Bases:
WikibaseEntity
Interface for MediaInfo entities on Commons.
Added in version 6.5.
Parameters
repo
DataSite
) – Entity repository.
id
– Entity identifier; -1 and None mean non-existing
id_
str
None
DATA_ATTRIBUTES
dict
str
Any
{'labels':
'statements':
addClaim
claim
bot
True
**
kwargs
[source]
Add a claim to the MediaInfo.
Added in version 8.5.
Parameters
claim
pywikibot.page.Claim
) – The claim to add
bot
bool
) – Whether to flag as bot (if possible)
Return type
None
editLabels
labels
**
kwargs
[source]
Edit MediaInfo labels (eg. captions).
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.
Usage:
>>>
repo
pywikibot
Site
'commons'
'commons'
>>>
page
pywikibot
FilePage
repo
'File:Sandbox-Test.svg'
>>>
item
page
data_item
()
>>>
item
editLabels
({
'en'
'Test file.'
})
Added in version 8.5.
Parameters
labels
LANGUAGE_TYPE
Return type
None
entity_type
'mediainfo'
property
file
FilePage
[source]
Get the file associated with the mediainfo.
get
force
False
[source]
Fetch all MediaInfo entity data and cache it.
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
Changed in version 9.0:
Added
pageid
ns
title
lastrevid
modified
id
values to
_content
attribute when it is loaded.
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
[source]
Get the entity identifier.
See also
title()
Parameters
numeric
bool
) – Strip the first letter and return an int
Raises
NoWikibaseEntityError
– If this entity is associated with
a non-existing file
Return type
str
int
removeClaims
claims
**
kwargs
[source]
Remove the claims from the MediaInfo.
Added in version 8.5.
Parameters
claims
List
or
Claim
) – List of claims to be removed
Return type
None
title
[source]
Return ID as title of the MediaInfo.
Added in version 9.4.
See also
getID()
Raises
NoWikibaseEntityError
– If this entity is associated with
a non-existing file
Returns
The entity identifier
Return type
str
title_pattern
'M[1-9]\\d*'
class
page.
Page
source
title
''
ns
[source]
Bases:
BasePage
WikiBlameMixin
WikiWhoMixin
Page: A MediaWiki page.
Instantiate a Page object.
Parameters
title
str
get_best_claim
prop
[source]
Return the first best Claim for this page.
Return the first ‘preferred’ ranked Claim specified by Wikibase
property or the first ‘normal’ one otherwise.
Added in version 3.0.
See also
pywikibot.ItemPage.get_best_claim()
Parameters
prop
str
) – Wikibase property ID, must be of the form
followed by one or more digits (e.g.
P31
).
Returns
Claim object given by Wikibase property number
for this page object.
Raises
UnknownExtensionError
– site has no Wikibase extension
Return type
Claim
None
property
raw_extracted_templates
[source]
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
True
botflag
'[deprecated
name
of
bot]'
**
kwargs
[source]
Change the page’s text to point to the redirect page.
Changed in version 9.3:
botflag
keyword parameter was renamed to
bot
Parameters
target_page
Page
str
) – 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.
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
[source]
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
tuple
Page
list
str
]]]
class
page.
Property
site
id
datatype
None
[source]
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
str
None
) – Datatype of the property; if not given, it will
be queried via the API
exists
[source]
Determine if the property exists in the data repository.
Added in version 9.4.
Return type
bool
getID
numeric
False
[source]
Get the identifier of this property.
Parameters
numeric
bool
) – Strip the first letter and return an int
property
type
str
[source]
Return the type of this property.
Changed in version 9.4:
raises
NoWikibaseEntityError
if property does not
exist.
Raises
NoWikibaseEntityError
– Property does not exist
types
{'commonsMedia':
'external-id':
'geo-shape':
'globe-coordinate':
'math':
'monolingualtext':
'musical-notation':
'quantity':
'string':
'tabular-data':
'time':
'url':
'wikibase-form':
'wikibase-item':
'wikibase-lexeme':
'wikibase-property':
'wikibase-sense':
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
[source]
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
None
) – 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':
'claims':
'descriptions':
'labels':
entity_type
'property'
get
force
False
args
**
kwargs
[source]
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
[source]
Get the identifier of this property.
Parameters
numeric
bool
) – Strip the first letter and return an int
get_data_for_new_entity
[source]
Return data required for creation of new property.
newClaim
args
**
kwargs
[source]
Helper function to create a new claim object for this property.
Return type
Claim
title_pattern
'P[1-9]\\d*'
class
page.
Revision
**
kwargs
[source]
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.:
>>>
Revision
comment
'Sample for Revision access'
>>>
comment
==
'comment'
True
>>>
comment
'Sample for Revision access'
See also
API:Revisions
API:Alldeletedrevisions
class
page.
SiteLink
title
site
None
badges
None
[source]
Bases:
BaseLink
A single sitelink in a Wikibase item.
Extends BaseLink by the following attribute:
badges: Any badges associated with the sitelink
Added 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
] or
None
) – List of badges
property
badges
[source]
Return a list of all badges associated with the link.
Return type
ItemPage
classmethod
fromJSON
data
site
None
[source]
Create a SiteLink object from JSON returned in the API call.
Parameters
data
dict
str
Any
) – JSON containing SiteLink data
site
pywikibot.site.DataSite
) – The Wikibase site
Return type
SiteLink
toJSON
[source]
Convert the SiteLink to a JSON object for the Wikibase API.
Returns
Wikibase JSON
Return type
dict
str
str
list
str
]]
class
page.
User
source
title
''
[source]
Bases:
Page
A class that represents a Wiki user.
This class also represents the Wiki page User:
Initializer for a User object.
All parameters are the same as for Page() Initializer.
Parameters
title
str
block
args
**
kwargs
[source]
Block user.
Refer
APISite.blockuser
method for parameters.
Return type
None
contributions
total
500
**
kwargs
[source]
Yield tuples describing this user edits.
Each tuple is composed of a pywikibot.Page object, the revision
id, the edit timestamp and the comment. Pages returned are not
guaranteed to be unique.
Example:
>>>
site
pywikibot
Site
'wikipedia:test'
>>>
user
pywikibot
User
site
'pywikibot-test'
>>>
contrib
next
user
contributions
reverse
True
))
>>>
len
contrib
>>>
contrib
title
()
'User:John Vandenberg/appendtext test'
>>>
contrib
504588
>>>
str
contrib
])
'2022-03-04T17:36:02Z'
>>>
contrib
''
See also
Site.usercontribs()
Parameters
total
int
None
) – 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
Generator
tuple
Page
int
Timestamp
str
None
]]
deleted_contributions
total
500
**
kwargs
[source]
Yield tuples describing this user’s deleted edits.
Added in version 5.5.
Parameters
total
int
None
) – 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
Generator
tuple
Page
Revision
]]
editCount
force
False
[source]
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
tuple
Page
int
Timestamp
str
None
None
[source]
Return first user contribution.
Returns
First user contribution entry
Returns
Tuple of pywikibot.Page, revid, pywikibot.Timestamp,
comment
gender
force
False
[source]
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
''
[source]
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
''
[source]
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
get_block_info
force
False
[source]
Return a dictionary of block information if the user is blocked.
Returns None if the user is not blocked.
The returned dictionary contains keys like:
blockid
blockedby
blockreason
blockexpiry
blockpartial (only if partial block)
See also
getprops()
is_partial_blocked()
Added in version 11.0.
Parameters
force
bool
) – If True, forces reloading the data from API
Return type
dict
str
Any
] |
None
getprops
force
False
[source]
Return a properties about the user.
Changed in version 9.0:
detect range blocks
Parameters
force
bool
) – If True, forces reloading the data from API
Return type
dict
str
Any
groups
force
False
[source]
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
[source]
Determine if the user is editing as an IP address.
See also
isRegistered()
is_CIDR()
tools.is_ip_address()
Return type
bool
isEmailable
force
False
[source]
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
[source]
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.
See also
isAnonymous()
Parameters
force
bool
) – If True, forces reloading the data from API
Return type
bool
is_CIDR
[source]
Determine if the input refers to a range of IP addresses.
Added in version 9.0.
See also
isRegistered()
isAnonymous()
tools.is_ip_network()
Return type
bool
is_blocked
force
False
[source]
Determine whether the user is currently blocked.
See also
is_partial_blocked()
get_block_info()
Changed in version 7.0:
renamed from
isBlocked()
method
Changed in version 9.0:
can also detect range blocks.
Parameters
force
bool
) – If True, forces reloading the data from API
Return type
bool
is_locked
force
False
[source]
Determine whether the user is currently locked globally.
Added in version 7.0.
Parameters
force
bool
) – If True, forces reloading the data from API
Return type
bool
is_partial_blocked
force
False
[source]
Return True if this user is partially blocked, False otherwise.
See also
get_block_info()
APISite.is_partial_blocked()
Added in version 11.0.
Parameters
force
bool
) – If True, forces reloading the data from API
Return type
bool
property
is_thankable
bool
[source]
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_activity
Timestamp
None
[source]
Return timestamp of last user activity.
This includes the last log event, last edit, last deleted
contribution, and last abuse log entry.
Added in version 11.0.
Returns
Timestamp of last user activity
property
last_edit
tuple
Page
int
Timestamp
str
None
None
[source]
Return last user contribution.
Returns
Last user contribution entry
Returns
Tuple of pywikibot.Page, revid, pywikibot.Timestamp,
comment
property
last_event
pywikibot.logentries.LogEntry
None
[source]
Return last user log event.
Returns
Last user log entry
logevents
**
kwargs
[source]
Yield user activities.
Keyword Arguments
logtype
str
) – 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
bool
) – If True, iterate oldest entries first
(default: newest)
tag
str
) – Only iterate entries tagged with this tag
total
int
) – Maximum number of events to iterate
Return type
iterable
registration
force
False
[source]
Fetch registration date for this user.
Parameters
force
bool
) – If True, forces reloading the data from API
Return type
Timestamp
None
renamed_target
[source]
Return a User object for the target this user was renamed to.
If this user was not renamed, it will raise a
NoRenameTargetError
Usage:
>>>
site
pywikibot
Site
'wikipedia:de'
>>>
user
pywikibot
User
site
'Foo'
>>>
user
isRegistered
()
False
>>>
target
user
renamed_target
()
>>>
target
isRegistered
()
True
>>>
target
title
with_ns
False
'Foo~dewiki'
>>>
target
renamed_target
()
Traceback (most recent call last):
...
pywikibot.exceptions.NoRenameTargetError
Rename target user ...
See also
BasePage.moved_target()
BasePage.getRedirectTarget()
Added in version 9.4.
Raises
NoRenameTargetError
– User was not renamed
Return type
User
rights
force
False
[source]
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
[source]
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
[source]
Remove the block for the user.
Parameters
reason
str
None
) – Reason for the unblock.
Return type
None
uploadedImages
total
10
[source]
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
[source]
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
[source]
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
(e.g., ‘labels’, ‘claims’) to appropriate collection classes
(e.g.,
LanguageDict
ClaimCollection
entity_type
str
) – entity type identifier
title_pattern
str
) – regular expression which matches all possible
entity ids for this entity type
Parameters
repo
DataSite
) – Entity repository.
id
– Entity identifier; -1 and None mean non-existing
id_
str
None
DATA_ATTRIBUTES
dict
str
Any
{}
concept_uri
[source]
Return the full concept URI.
Raises
NoWikibaseEntityError
– if this entity’s id is not known
Return type
str
editEntity
data
None
**
kwargs
[source]
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()
Changed in version 8.0.1:
Copy snak IDs/hashes (
T327607
Parameters
data
ENTITY_DATA_TYPE
None
) – Data to be saved
Return type
None
exists
[source]
Determine if an entity exists in the data repository.
Return type
bool
get
force
False
[source]
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
[source]
Get the identifier of this entity.
Parameters
numeric
bool
) – Strip the first letter and return an int
Return type
int
str
get_data_for_new_entity
[source]
Return data required for creation of a new entity.
Override it if you need.
Return type
dict
classmethod
is_valid_id
entity_id
[source]
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
int
None
[source]
Get the revision id 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
[source]
Create JSON suitable for Wikibase API.
When diffto is provided, JSON representing differences to the
provided data is created.
Parameters
diffto
dict
None
) – JSON containing entity data
Return type
dict
class
page.
WikibasePage
site
title
''
**
kwargs
[source]
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
[source]
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
[source]
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
[source]
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
ALIASES_TYPE
Return type
None
editDescriptions
descriptions
**
kwargs
[source]
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
LANGUAGE_TYPE
Return type
None
editEntity
data
None
**
kwargs
[source]
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
WikibasePage
object
err
an Exception instance, which will be None if the page was
saved successfully
See also
WikibaseEntity.editEntity()
Parameters
data
ENTITY_DATA_TYPE
None
) – 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
[source]
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
LANGUAGE_TYPE
Return type
None
exists
[source]
Determine if an entity exists in the data repository.
Return type
bool
get
force
False
args
**
kwargs
[source]
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
[source]
Get the revision id for the most recent revision of the entity.
Return type
int
Raises
pywikibot.exceptions.NoPageError
– if the entity doesn’t
exist
namespace
[source]
Return the number of the namespace of the entity.
Returns
Namespace id
Return type
int
removeClaims
claims
**
kwargs
[source]
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
True
**
kwargs
[source]
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
bool
Return type
NoReturn
page.
html2unicode
text
ignore
None
exceptions
None
[source]
Replace HTML entities with equivalent unicode.
Parameters
ignore
list
int
None
) – HTML entities to ignore
text
str
Return type
str
page._collections
Wikibase Entity Structures
Structures holding data for Wikibase entities.
class
pywikibot.page._collections.
AliasesDict
data
None
[source]
Bases:
BaseDataDict
A structure holding aliases for a Wikibase entity.
It is a mapping from a language to a list of strings.
Parameters
data
dict
str
Any
classmethod
fromJSON
data
repo
None
[source]
Construct a new AliasesDict from JSON.
classmethod
normalizeData
data
[source]
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
[source]
Create JSON suitable for Wikibase API.
When diffto is provided, JSON representing differences to the
provided data is created.
Parameters
diffto
dict
None
) – JSON containing entity data
Return type
dict
class
pywikibot.page._collections.
ClaimCollection
repo
[source]
Bases:
MutableMapping
A structure holding claims for a Wikibase entity.
classmethod
fromJSON
data
repo
[source]
Construct a new ClaimCollection from JSON.
classmethod
new_empty
repo
[source]
Construct a new empty ClaimCollection.
classmethod
normalizeData
data
[source]
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
[source]
Set Claim.on_item attribute for all claims in this collection.
Return type
None
toJSON
diffto
None
[source]
Create JSON suitable for Wikibase API.
When diffto is provided, JSON representing differences to the
provided data is created.
Parameters
diffto
dict
None
) – JSON containing entity data
Return type
dict
class
pywikibot.page._collections.
LanguageDict
data
None
[source]
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.
Parameters
data
dict
str
Any
classmethod
fromJSON
data
repo
None
[source]
Construct a new LanguageDict from JSON.
classmethod
normalizeData
data
[source]
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
[source]
Create JSON suitable for Wikibase API.
When diffto is provided, JSON representing differences to the
provided data is created.
Parameters
diffto
dict
None
) – JSON containing entity data
Return type
dict
class
pywikibot.page._collections.
SiteLinkCollection
repo
data
None
[source]
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
[source]
Construct a new SiteLinkCollection from JSON.
static
getdbName
site
[source]
Helper function to obtain a dbName for a Site.
Parameters
site
BaseSite
str
) – The site to look up.
classmethod
new_empty
repo
[source]
Construct a new empty SiteLinkCollection.
classmethod
normalizeData
data
[source]
Helper function to expand data into the Wikibase API structure.
Parameters
data
list
dict
str
Any
) – Data to normalize
Returns
The dict with normalized data
Return type
dict
toJSON
diffto
None
[source]
Create JSON suitable for Wikibase API.
When diffto is provided, JSON representing differences to the
provided data is created.
Parameters
diffto
dict
None
) – JSON containing entity data
Return type
dict
class
pywikibot.page._collections.
SubEntityCollection
repo
data
None
[source]
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
[source]
Construct a new SubEntityCollection from JSON.
insert
index
obj
[source]
Insert a sub-entity to the collection.
Return type
None
classmethod
new_empty
repo
[source]
Construct a new empty SubEntityCollection.
classmethod
normalizeData
data
[source]
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
[source]
Create JSON suitable for Wikibase API.
When diffto is provided, JSON representing differences to the
provided data is created.
Parameters
diffto
dict
None
) – JSON containing entity data
Return type
dict
class
pywikibot.page._collections.
BaseDataDict
data
None
[source]
Bases:
MutableMapping
Base structure holding data for a Wikibase entity.
Data are mappings from a language to a value. It will be specialised
in subclasses.
Parameters
data
dict
str
Any
classmethod
new_empty
repo
[source]
Construct a new empty BaseDataDict.
static
normalizeKey
key
[source]
Helper function to return language codes of a site object.
Parameters
key
pywikibot.site.BaseSite
or
str
) – Input key to be normalized
Return type
str
page._decorators
— Page Decorators
Decorators for Page objects.
page._decorators.
allow_asynchronous
func
[source]
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._revision
— Page Revision
Object representing page revision.
class
page._revision.
Revision
**
kwargs
[source]
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.:
>>>
Revision
comment
'Sample for Revision access'
>>>
comment
==
'comment'
True
>>>
comment
'Sample for Revision access'
See also
API:Revisions
API:Alldeletedrevisions
page._toolforge
module
Object representing interface to toolforge tools.
Added in version 7.7.
class
page._toolforge.
WikiBlameMixin
[source]
Bases:
object
Page mixin for main authorship.
Added in version 7.7.
WIKIBLAME_CODES
('als',
'bar',
'de',
'en',
'it',
'nds',
'sco')
Supported wikipedia site codes
authorship
None
min_chars
min_pct
0.0
max_pct_sum
None
[source]
Retrieve authorship attribution of an article.
This method uses WikiHistory to retrieve the authors measured by
character count.
Sample:
>>>
import
pywikibot
>>>
site
pywikibot
Site
'wikipedia:en'
>>>
page
pywikibot
Page
site
'Pywikibot'
>>>
auth
page
authorship
()
>>>
auth
{'1234qwer1234qwer4': (68, 100.0)}
Important
Only implemented for pages in Main, Project,
Category and Template namespaces and only wikipedias of
WIKIBLAME_CODES
are supported.
Added in version 9.3:
XTools is used to retrieve authors. This method replaces
main_authors()
Changed in version 10.1:
WikiHistory is used to retrieve authors due to
T392694
Here are the differences between these two implementations:
Added in version 10.1.
Implemented from version 7.7 until 9.2 (with
main_authors()
method) and from 10.1.
Main, Project, Category and Template namespaces are
supported
Only ‘als’, ‘bar’, ‘de’, ‘en’, ‘it’, ‘nds’ and ‘sco’
Wikipedias are supported.
Revision ID
revid
or revision
date
is not supported.
Always the latest revision is used.
Only the most 5 authors are given.
No additional parsing library is required.
See also
Removed in version 10.1.
Implemented from version 9.3 until 10.0.
Only Main namespace is supported.
Only ‘ar’, ‘de’, ‘en’, ‘es’, ‘eu’, ‘fr’, ‘hu’, ‘id’,
‘it’, ‘ja’, ‘nl’, ‘pl’, ‘pt’ and ‘tr’ Wikipedias are
supported.
Revision ID
revid
or revision
date
is supported to
get authorship for this revision.
All authors can be given.
wikitextparser parsing library is required.
See also
Parameters
int
None
) – Only return the first
or fewer authors.
min_chars
int
) – Only return authors with more than
min_chars
chars changes.
min_pct
float
) – Only return authors with more than
min_pct
percentage edits.
max_pct_sum
float
None
) – Only return authors until the prcentage sum
reached
max_pct_sum
Returns
Character count and percentage of edits for each
username.
Raises
NotImplementedError
– unsupported site or unsupported
namespace.
NoPageError
– The page does not exist.
TimeoutError
– WikiHistory timeout
Return type
dict
str
tuple
int
float
]]
main_authors
onlynew
NotImplemented
[source]
Deprecated; use authorsship instead.
Retrieve the 5 topmost main authors of an article.
Sample:
>>>
import
pywikibot
>>>
site
pywikibot
Site
'wikipedia:de'
>>>
page
pywikibot
Page
site
'Project:Pywikibot'
>>>
auth
page
main_authors
()
>>>
auth
most_common
[('DrTrigon', 37)]
Deprecated since version 9.3:
use
authorship()
instead.
See also
authorship()
for further informations
Returns
Percentage of edits for each username
Raises
NotImplementedError
– unsupported site or unsupported
namespace.
NoPageError
– The page does not exist.
TimeoutError
– WikiHistory timeout
Return type
Any
class
page._toolforge.
WikiWhoMixin
[source]
Bases:
object
Page mixin for WikiWho authorship data with optimized pickle storage.
WikiWho provides token-level provenance and authorship information.
This implementation uses an optimized subdirectory structure for pickle
caching to avoid filesystem performance issues with millions of files.
Added in version 11.0.
WIKIWHO_CODES
('ar',
'de',
'en',
'es',
'eu',
'fr',
'hu',
'id',
'it',
'ja',
'nl',
'pl',
'pt',
'tr',
'zh')
Supported WikiWho API language codes
get_annotations
use_cache
True
[source]
Get WikiWho annotations for article revisions.
This method uses the public WikiWho API to get token-level
provenance annotations showing who added each token in the article.
Results are cached locally using pickle files with an optimized
subdirectory structure to avoid filesystem performance issues.
Sample:
>>>
import
pywikibot
>>>
site
pywikibot
Site
'wikipedia:en'
>>>
page
pywikibot
Page
site
'Python (programming language)'
>>>
data
page
get_annotations
()
>>>
data
'article_title'
'Python (programming language)'
Important
Only implemented for main namespace pages and only
Wikipedias of
WIKIWHO_CODES
are supported.
Added in version 11.0.
See also
Parameters
use_cache
bool
) – Whether to use and save cached data.
Set to False to force a fresh API request without caching.
Returns
Dictionary containing article_title, page_id, and revisions
with token-level annotations
Raises
NotImplementedError
– unsupported site, language, or namespace
NoPageError
– page does not exist
pywikibot.exceptions.ServerError
– WikiWho API error
requests.exceptions.HTTPError
– HTTP error from WikiWho API
Return type
dict
str
Any
On this page
page
— MediaWiki Pages
BaseLink
astext()
canonical_title()
fromPage()
lookup_namespace()
namespace
ns_title()
site
BasePage
applicable_protections()
autoFormat()
backlinks()
botMayEdit()
categories()
change_category()
clear_cache()
content_model
contributors()
coordinates()
create_short_link()
data_item()
data_repository
defaultsort()
delete()
depth
embeddedin()
exists()
expand_text()
extlinks()
extract()
full_url()
get()
getCategoryRedirectTarget()
getDeletedRevision()
getOldVersion()
getRedirectTarget()
getReferences()
getVersionHistoryTable()
get_parsed_page()
get_revision()
has_content()
has_deleted_revisions()
has_permission()
image_repository
imagelinks()
interwiki()
isAutoTitle()
isCategoryRedirect()
isDisambig()
isIpEdit()
isRedirectPage()
isStaticRedirect()
isTalkPage()
is_categorypage()
is_filepage()
is_flow_page()
iterlanglinks()
itertemplates()
langlinks()
lastNonBotUser()
latest_revision
latest_revision_id
linkedPages()
loadDeletedRevisions()
markDeletedRevision()
merge_history()
move()
moved_target()
namespace()
oldest_revision
page_image()
pageid
permalink()
preloadText()
properties()
protect()
protection()
purge()
put()
redirects()
revision_count()
revisions()
rollback()
save()
section()
site
templates()
text
title()
toggleTalkPage()
touch()
undelete()
userName()
version()
watch()
Category
articles()
aslink()
categoryinfo
isEmptyCategory()
isHiddenCategory()
members()
newest_pages()
subcategories()
Claim
SNAK_TYPES
TARGET_CONVERTER
addQualifier()
addSource()
addSources()
changeRank()
changeSnakType()
changeTarget()
copy()
fromJSON()
getRank()
getSnakType()
getSources()
getTarget()
has_better_rank()
has_qualifier()
on_item
qualifierFromJSON()
referenceFromJSON()
removeQualifier()
removeQualifiers()
removeSource()
removeSources()
same_as()
setRank()
setSnakType()
setTarget()
target_equals()
toJSON()
FileInfo
metadata
update()
FilePage
data_item()
download()
file_is_shared()
file_is_used
getFileVersionHistoryTable()
getImagePageHtml()
get_file_history()
get_file_info()
get_file_url()
globalusage()
latest_file_info
oldest_file_info
upload()
using_pages()
ItemPage
DATA_ATTRIBUTES
entity_type
fromPage()
from_entity_uri()
get()
getID()
getRedirectTarget()
getSitelink()
get_best_claim()
get_value_at_timestamp()
isRedirectPage()
iterlinks()
mergeInto()
removeSitelink()
removeSitelinks()
setSitelink()
setSitelinks()
set_redirect_target()
title()
title_pattern
LexemeForm
DATA_ATTRIBUTES
edit_elements()
entity_type
get()
title_pattern
toJSON()
LexemePage
DATA_ATTRIBUTES
add_form()
entity_type
get()
get_data_for_new_entity()
isRedirectPage()
mergeInto()
remove_form()
title_pattern
toJSON()
LexemeSense
DATA_ATTRIBUTES
entity_type
title_pattern
Link
anchor
astext()
create_separated()
fromPage()
illegal_titles_pattern
langlinkUnsafe()
namespace
parse()
parse_site()
section
site
title
MediaInfo
DATA_ATTRIBUTES
addClaim()
editLabels()
entity_type
file
get()
getID()
removeClaims()
title()
title_pattern
Page
get_best_claim()
raw_extracted_templates
set_redirect_target()
templatesWithParams()
Property
exists()
getID()
type
types
value_types
PropertyPage
DATA_ATTRIBUTES
entity_type
get()
getID()
get_data_for_new_entity()
newClaim()
title_pattern
Revision
SiteLink
badges
fromJSON()
toJSON()
User
block()
contributions()
deleted_contributions()
editCount()
first_edit
gender()
getUserPage()
getUserTalkPage()
get_block_info()
getprops()
groups()
isAnonymous()
isEmailable()
isRegistered()
is_CIDR()
is_blocked()
is_locked()
is_partial_blocked()
is_thankable
last_activity
last_edit
last_event
logevents()
registration()
renamed_target()
rights()
send_email()
unblock()
uploadedImages()
username
WikibaseEntity
DATA_ATTRIBUTES
concept_uri()
editEntity()
exists()
get()
getID()
get_data_for_new_entity()
is_valid_id()
latest_revision_id
toJSON()
WikibasePage
addClaim()
botMayEdit()
editAliases()
editDescriptions()
editEntity()
editLabels()
exists()
get()
latest_revision_id
namespace()
removeClaims()
set_redirect_target()
html2unicode()
page._collections
Wikibase Entity Structures
AliasesDict
fromJSON()
normalizeData()
toJSON()
ClaimCollection
fromJSON()
new_empty()
normalizeData()
set_on_item()
toJSON()
LanguageDict
fromJSON()
normalizeData()
toJSON()
SiteLinkCollection
fromJSON()
getdbName()
new_empty()
normalizeData()
toJSON()
SubEntityCollection
fromJSON()
insert()
new_empty()
normalizeData()
toJSON()
BaseDataDict
new_empty()
normalizeKey()
page._decorators
— Page Decorators
allow_asynchronous()
page._revision
— Page Revision
Revision
page._toolforge
module
WikiBlameMixin
WIKIBLAME_CODES
authorship()
main_authors()
WikiWhoMixin
WIKIWHO_CODES
get_annotations()
US