scripts package

Scripts folder contains predefined scripts easy to use.

Scripts are only available with Pywikibot if installed in directory mode and not as site package. They can be run in command line using the pwb wrapper script:

python pwb.py <global options> <name_of_script> <options>

Every script provides a -help option which shows all available options, their explanation and usage examples. Global Options will be shown by -help:global or using:

python pwb.py -help

The advantages of pwb.py wrapper script are:

• check for framework and script depedencies and show a warning if a package is missing or outdated or if the Python release does not fit

• check whether user-config.py config file is available and ask to create it by starting the generate_user_files.py script

• enable global options even if a script does not support them

• start private scripts located in userscripts sub-folder

• find a script even if given script name does not match a filename e.g. due to spelling mistake

Scripts Subpackages

• scripts.i18n translation files
• scripts.maintenance utility scripts
  • Submodules
  • scripts.maintenance.cache script
  • scripts.maintenance.colors script
  • scripts.maintenance.make_i18n_dict script
  • scripts.maintenance.sorting_order script
  • scripts.maintenance.wikimedia_sites script
• scripts.userscripts user scripts

add_text script

Append text to the top or bottom of a page

By default this adds the text to the bottom above the categories and interwiki.

Use the following command line parameters to specify what to add:

-text             Text to append. "\n" are interpreted as newlines.

-textfile         Path to a file with text to append

-summary          Change summary to use

-up               Append text to the top of the page rather than the bottom

-create           Create the page if necessary. Note that talk pages are
                  created already without of this option.

-createonly       Only create the page but do not edit existing ones

-always           If used, the bot won't ask if it should add the specified
                  text

-major            If used, the edit will be saved without the "minor edit" flag

-talkpage         Put the text onto the talk page instead
-talk

-excepturl        Skip pages with a url that matches this regular expression

-noreorder        Place the text beneath the categories and interwiki

Furthermore, the following can be used to specify which pages to process…

This script supports use of pywikibot.pagegenerators arguments.

Examples

1. Append ‘hello world’ to the bottom of the sandbox:

   python pwb.py add_text -page:Wikipedia:Sandbox \
       -summary:"Bot: pywikibot practice" -text:"hello world"
   

2. Add a template to the top of the pages with ‘category:catname’:

   python pwb.py add_text -cat:catname -summary:"Bot: Adding a template" \
       -text:"{{Something}}" -except:"\{\{([Tt]emplate:|)[Ss]omething" -up
   

3. Command used on it.wikipedia to put the template in the page without any category:

   python pwb.py add_text -except:"\{\{([Tt]emplate:|)[Cc]ategorizzare" \
       -text:"{{Categorizzare}}" -excepturl:"class='catlinks'>" -uncat \
       -summary:"Bot: Aggiungo template Categorizzare"
   

class scripts.add_text.AddTextBot(**kwargs)

Bases: pywikibot.bot.AutomaticTWSummaryBot, pywikibot.bot.ExistingPageBot

A bot which adds a text to a page.

Parameters

kwargs (Any) – bot options

Keyword Arguments

generator – a generator processed by run() method

Return type

None

setup()

Read text to be added from file.

Return type

None

skip_page(page)

Skip if -exceptUrl matches or page does not exists.

summary_key = 'add_text-adding'

Must be defined in subclasses.

property summary_parameters

Return a dictionary of all parameters for i18n.

Line breaks are replaced by dash.

treat_page()

Add text to the page.

Return type

None

update_options = {'always': False, 'create': False, 'createonly': False, 'minor': True, 'regex_skip_url': '', 'reorder': True, 'summary': '', 'talk_page': False, 'text': '', 'textfile': '', 'up': False}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

use_redirects = False

Attribute to determine whether to use redirect pages. Set it to True to use redirects only, set it to False to skip redirects. If None both are processed. For example to create a RedirectBot you may define:

class MyRedirectBot(ExistingPageBot):

    '''Bot who only works on existing redirects.'''

    use_redirects = True

New in version 7.2.

scripts.add_text.main(*argv)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

argv (str) – Command line arguments

Return type

None

scripts.add_text.parse(argv, generator_factory)

Parses our arguments and provide a dictionary with their values.

Parameters

• argv (Sequence[str]) – input arguments to be parsed

• generator_factory (pywikibot.pagegenerators.GeneratorFactory) – factory that will determine what pages to process

Returns

dictionary with our parsed arguments

Raises

ValueError – if we receive invalid arguments

Return type

Dict[str, Union[bool, str]]

archivebot script

archivebot.py - discussion page archiving bot

usage:

python pwb.py archivebot [OPTIONS] TEMPLATE_PAGE

Bot examines backlinks (Special:WhatLinksHere) to TEMPLATE_PAGE. Then goes through all pages (unless a specific page specified using options) and archives old discussions. This is done by breaking a page into threads, then scanning each thread for timestamps. Threads older than a specified threshold are then moved to another page (the archive), which can be named either basing on the thread’s name or then name can contain a counter which will be incremented when the archive reaches a certain size.

Transcluded template may contain the following parameters:

{{TEMPLATE_PAGE
|archive =
|algo =
|counter =
|maxarchivesize =
|minthreadsleft =
|minthreadstoarchive =
|archiveheader =
|key =
}}

Meanings of parameters are:

archive              Name of the page to which archived threads will be put.
                     Must be a subpage of the current page. Variables are
                     supported.
algo                 Specifies the maximum age of a thread. Must be
                     in the form old(<delay>) where <delay> specifies
                     the age in seconds (s), hours (h), days (d),
                     weeks (w), or years (y) like 24h or 5d. Default is
                     old(24h).
counter              The current value of a counter which could be assigned as
                     variable. Will be updated by bot. Initial value is 1.
maxarchivesize       The maximum archive size before incrementing the counter.
                     Value can be given with appending letter like K or M
                     which indicates KByte or MByte. Default value is 200K.
minthreadsleft       Minimum number of threads that should be left on a page.
                     Default value is 5.
minthreadstoarchive  The minimum number of threads to archive at once. Default
                     value is 2.
archiveheader        Content that will be put on new archive pages as the
                     header. This parameter supports the use of variables.
                     Default value is {{talkarchive}}
key                  A secret key that (if valid) allows archives not to be
                     subpages of the page being archived.

Variables below can be used in the value for “archive” in the template above:

%(counter)d          the current value of the counter
%(year)d             year of the thread being archived
%(isoyear)d          ISO year of the thread being archived
%(isoweek)d          ISO week number of the thread being archived
%(semester)d         semester term of the year of the thread being archived
%(quarter)d          quarter of the year of the thread being archived
%(month)d            month (as a number 1-12) of the thread being archived
%(monthname)s        localized name of the month above
%(monthnameshort)s   first three letters of the name above
%(week)d             week number of the thread being archived

The ISO calendar starts with the Monday of the week which has at least four days in the new Gregorian calendar. If January 1st is between Monday and Thursday (including), the first week of that year started the Monday of that week, which is in the year before if January 1st is not a Monday. If it’s between Friday or Sunday (including) the following week is then the first week of the year. So up to three days are still counted as the year before.

See also

Python datetime.date.isocalendar, https://webspace.science.uu.nl/~gent0113/calendar/isocalendar.htm

Options (may be omitted):

-help           show this help message and exit
-calc:PAGE      calculate key for PAGE and exit
-file:FILE      load list of pages from FILE
-force          override security options
-locale:LOCALE  switch to locale LOCALE
-namespace:NS   only archive pages from a given namespace
-page:PAGE      archive a single PAGE, default ns is a user talk page
-salt:SALT      specify salt

exception scripts.archivebot.AlgorithmError(arg)

Bases: scripts.archivebot.MalformedConfigError

Invalid specification of archiving algorithm.

Parameters

arg (str) –

Return type

None

exception scripts.archivebot.ArchiveBotSiteConfigError(arg)

Bases: pywikibot.exceptions.Error

There is an error originated by archivebot’s on-site configuration.

Parameters

arg (str) –

Return type

None

exception scripts.archivebot.ArchiveSecurityError(arg)

Bases: scripts.archivebot.ArchiveBotSiteConfigError

Page title is not a valid archive of page being archived.

The page title is neither a subpage of the page being archived, nor does it match the key specified in the archive configuration template.

Parameters

arg (str) –

Return type

None

class scripts.archivebot.DiscussionPage(source, archiver, params=None)

Bases: pywikibot.page._pages.Page

A class that represents a single page of discussion threads.

Feed threads to it and run an update() afterwards.

Return type

None

feed_thread(thread, max_archive_size)

Append a new thread to the archive.

Parameters

• thread (scripts.archivebot.DiscussionThread) –

• max_archive_size (Tuple[int, str]) –

Return type

bool

is_full(max_archive_size)

Check whether archive size exceeded.

Parameters

max_archive_size (Tuple[int, str]) –

Return type

bool

load_page()

Load the page to be archived and break it up into threads.

Return type

None

size()

Return size of talk page threads.

Note that this method counts bytes, rather than codepoints (characters). This corresponds to MediaWiki’s definition of page size.

Return type

int

update(summary, sort_threads=False)

Recombine threads and save page.

Parameters

sort_threads (bool) –

Return type

None

class scripts.archivebot.DiscussionThread(title, timestripper)

Bases: object

An object representing a discussion thread on a page.

It represents something that is of the form:

== Title of thread ==

Thread content here. ~~~~
:Reply, etc. ~~~~

Parameters

• title (str) –

• timestripper (pywikibot.textlib.TimeStripper) –

Return type

None

feed_line(line)

Add a line to the content and find the newest timestamp.

Parameters

line (str) –

Return type

None

size()

Return size of discussion thread.

Note that the result is NOT equal to that of len(self.to_text()). This method counts bytes, rather than codepoints (characters). This corresponds to MediaWiki’s definition of page size.

Return type

int

to_text()

Return wikitext discussion thread.

Return type

str

exception scripts.archivebot.MalformedConfigError(arg)

Bases: scripts.archivebot.ArchiveBotSiteConfigError

There is an error in the configuration template.

Parameters

arg (str) –

Return type

None

exception scripts.archivebot.MissingConfigError(arg)

Bases: scripts.archivebot.ArchiveBotSiteConfigError

The config is missing in the header.

It’s in one of the threads or transcluded from another page.

Parameters

arg (str) –

Return type

None

class scripts.archivebot.PageArchiver(page, template, salt, force=False)

Bases: object

A class that encapsulates all archiving methods.

Parameters

• page (pywikibot.Page) – a page object to be archived

• template (pywikibot.Page) – a template with configuration settings

• salt (str) – salt value

• force (bool) – override security value

Return type

None

algo = 'none'

analyze_page()

Analyze DiscussionPage.

Return type

Set[Tuple[str, str]]

attr2text()

Return a template with archiver saveable attributes.

Return type

str

get_archive_page(title, params=None)

Return the page for archiving.

If it doesn’t exist yet, create and cache it. Also check for security violations.

Parameters

title (str) –

Return type

scripts.archivebot.DiscussionPage

get_attr(attr, default='')

Get an archiver attribute.

Return type

Any

get_params(timestamp, counter)

Make params for archiving template.

Parameters

counter (int) –

Return type

dict

key_ok()

Return whether key is valid.

Return type

bool

load_config()

Load and validate archiver template.

Return type

None

run()

Process a single DiscussionPage object.

Return type

None

saveables()

Return a list of saveable attributes.

Return type

List[str]

set_attr(attr, value, out=True)

Set an archiver attribute.

Parameters

out (bool) –

Return type

None

should_archive_thread(thread)

Check whether a thread has to be archived.

Returns

the archivation reason as a tuple of localization args

Parameters

thread (scripts.archivebot.DiscussionThread) –

Return type

Optional[Tuple[str, str]]

class scripts.archivebot.TZoneUTC

Bases: datetime.tzinfo

Class building a UTC tzinfo object.

dst(dt)

Subclass implementation, return timedelta(0).

Return type

datetime.timedelta

tzname(dt)

Subclass implementation.

Return type

str

utcoffset(dt)

Subclass implementation, return timedelta(0).

Return type

datetime.timedelta

scripts.archivebot.calc_md5_hexdigest(txt, salt)

Return md5 hexdigest computed from text and salt.

Return type

str

scripts.archivebot.checkstr(string)

Return the key and duration extracted from the string.

Parameters

string (str) – a string defining a time period

Return type

Tuple[str, str]

Examples:

300s - 300 seconds
36h - 36 hours
7d - 7 days
2w - 2 weeks (14 days)
1y - 1 year

Returns

key and duration extracted form the string

Parameters

string (str) –

Return type

Tuple[str, str]

scripts.archivebot.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

scripts.archivebot.str2localized_duration(site, string)

Localise a shorthand duration.

Translates a duration written in the shorthand notation (ex. “24h”, “7d”) into an expression in the local wiki language (“24 hours”, “7 days”).

Parameters

string (str) –

Return type

str

scripts.archivebot.str2size(string)

Return a size for a shorthand size.

Accepts a string defining a size:

1337 - 1337 bytes
150K - 150 kilobytes
2M - 2 megabytes

Returns

a tuple (size, unit), where size is an integer and unit is 'B' (bytes) or 'T' (threads).

Parameters

string (str) –

Return type

Tuple[int, str]

scripts.archivebot.str2time(string, timestamp=None)

Return a timedelta for a shorthand duration.

Parameters

string (str) – a string defining a time period:

Return type

datetime.timedelta

Examples:

300s - 300 seconds
36h - 36 hours
7d - 7 days
2w - 2 weeks (14 days)
1y - 1 year

Parameters

• timestamp (datetime.datetime) – a timestamp to calculate a more accurate duration offset used by years

• string (str) –

Returns

the corresponding timedelta object

Return type

datetime.timedelta

scripts.archivebot.template_title_regex(tpl_page)

Return a regex that matches to variations of the template title.

It supports the transcluding variant as well as localized namespaces and case-insensitivity depending on the namespace.

Parameters

tpl_page (pywikibot.page.Page) – The template page

Return type

Pattern

basic script

An incomplete sample script

This is not a complete bot; rather, it is a template from which simple bots can be made. You can rename it to mybot.py, then edit it in whatever way you want.

Use global -simulate option for test purposes. No changes to live wiki will be done.

The following parameters are supported:

-always           The bot won't ask for confirmation when putting a page

-text:            Use this text to be added; otherwise 'Test' is used

-replace:         Don't add text but replace it

-top              Place additional text on top of the page

-summary:         Set the action summary message for the edit.

This sample script is a ConfigParserBot. All settings can be made either by giving option with the command line or with a settings file which is scripts.ini by default. If you don’t want the default values you can add any option you want to change to that settings file below the [basic] section like:

[basic] ; inline comments starts with colon
# This is a commend line. Assignments may be done with '=' or ':'
text: A text with line break and
    continuing on next line to be put
replace: yes ; yes/no, on/off, true/false and 1/0 is also valid
summary = Bot: My first test edit with pywikibot

Every script has its own section with the script name as header.

In addition the following generators and filters are supported but cannot be set by settings file:

This script supports use of pywikibot.pagegenerators arguments.

class scripts.basic.BasicBot(site=True, **kwargs)

Bases: pywikibot.bot.SingleSiteBot, pywikibot.bot.ConfigParserBot, pywikibot.bot.ExistingPageBot, pywikibot.bot.AutomaticTWSummaryBot

An incomplete sample bot.

Variables

summary_key – Edit summary message key. The message that should be used is placed on /i18n subdirectory. The file containing these messages should have the same name as the caller script (i.e. basic.py in this case). Use summary_key to set a default edit summary message.

Parameters

• site (Optional[Union[BaseSite, bool]]) –

• kwargs (Any) –

Return type

None

Create a SingleSiteBot instance.

Parameters

• site (Optional[Union[BaseSite, bool]]) – If True it’ll be set to the configured site using pywikibot.Site.

• kwargs (Any) –

Return type

None

summary_key = 'basic-changing'

Must be defined in subclasses.

treat_page()

Load the given page, do some changes, and save it.

Return type

None

update_options = {'replace': False, 'summary': None, 'text': 'Test', 'top': False}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

use_redirects = False

Attribute to determine whether to use redirect pages. Set it to True to use redirects only, set it to False to skip redirects. If None both are processed. For example to create a RedirectBot you may define:

class MyRedirectBot(ExistingPageBot):

    '''Bot who only works on existing redirects.'''

    use_redirects = True

New in version 7.2.

scripts.basic.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

blockpageschecker script

A bot to remove stale protection templates from pages that are not protected

Very often sysops block the pages for a set time but then they forget to remove the warning! This script is useful if you want to remove those useless warning left in these pages.

These command line parameters can be used to specify which pages to work on:

This script supports use of pywikibot.pagegenerators arguments.

Furthermore, the following command line parameters are supported:

-protectedpages  Check all the blocked pages; useful when you have not
                 categories or when you have problems with them. (add the
                 namespace after ":" where you want to check - default checks
                 all protected pages.)

-moveprotected   Same as -protectedpages, for moveprotected pages

This script is a ConfigParserBot. The following options can be set within a settings file which is scripts.ini by default::

-always          Doesn't ask every time whether the bot should make the change.
                 Do it always.

-show            When the bot can't delete the template from the page (wrong
                 regex or something like that) it will ask you if it should
                 show the page on your browser.
                 (attention: pages included may give false positives!)

-move            The bot will check if the page is blocked also for the move
                 option, not only for edit

Examples::

python pwb.py blockpageschecker -always

python pwb.py blockpageschecker -cat:Geography -always

python pwb.py blockpageschecker -show -protectedpages:4

class scripts.blockpageschecker.CheckerBot(site=True, **kwargs)

Bases: pywikibot.bot.ConfigParserBot, pywikibot.bot.ExistingPageBot, pywikibot.bot.SingleSiteBot

Bot to remove stale protection templates from unprotected pages.

Changed in version 7.0: CheckerBot is a ConfigParserBot

Create a SingleSiteBot instance.

Parameters

• site (Optional[Union[BaseSite, bool]]) – If True it’ll be set to the configured site using pywikibot.Site.

• kwargs (Any) –

Return type

None

invoke_editor(page)

Ask for an editor and invoke it.

Return type

None

remove_templates()

Understand if the page is blocked has the right template.

setup()

Initialize the coroutine for parsing templates.

Return type

None

skip_page(page)

Skip if the user has not permission to edit.

teardown()

Close the coroutine.

Return type

None

treat_page()

Load the given page, do some changes, and save it.

Return type

None

update_options = {'move': False, 'show': False}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

class scripts.blockpageschecker.ParsedTemplate(blocktype, regex, msgtype)

Bases: tuple

Create new instance of ParsedTemplate(blocktype, regex, msgtype)

property blocktype

Alias for field number 0

property msgtype

Alias for field number 2

property regex

Alias for field number 1

scripts.blockpageschecker.main(*args)

Process command line arguments and perform task.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

category script

Script to manage categories

Syntax:

python pwb.py category action [-option]

where action can be one of these

• add - mass-add a category to a list of pages.

• remove - remove category tag from all pages in a category.

• move - move all pages in a category to another category.

• tidy - tidy up a category by moving its pages into subcategories.

• tree - show a tree of subcategories of a given category.

• listify - make a list of all of the articles that are in a category.

• clean - automatically clean specified category.

and option can be one of these

Options for “add” action:

-person      - Sort persons by their last name.
-create      - If a page doesn't exist, do not skip it, create it instead.
-redirect    - Follow redirects.

Options for “listify” action:

-append      - This appends the list to the current page that is already
               existing (appending to the bottom by default).
-overwrite   - This overwrites the current page with the list even if
               something is already there.
-showimages  - This displays images rather than linking them in the list.
-talkpages   - This outputs the links to talk pages of the pages to be
               listified in addition to the pages themselves.
-prefix:#    - You may specify a list prefix like "#" for a numbered list or
               any other prefix. Default is a bullet list with prefix "*".

Options for “remove” action:

-nodelsum    - This specifies not to use the custom edit summary as the
               deletion reason. Instead, it uses the default deletion reason
               for the language, which is "Category was disbanded" in
               English.

Options for “move” action:

-hist        - Creates a nice wikitable on the talk page of target category
               that contains detailed page history of the source category.
-nodelete    - Don't delete the old category after move.
-nowb        - Don't update the Wikibase repository.
-allowsplit  - If that option is not set, it only moves the talk and main
               page together.
-mvtogether  - Only move the pages/subcategories of a category, if the
               target page (and talk page, if -allowsplit is not set)
               doesn't exist.
-keepsortkey - Use sortKey of the old category also for the new category.
               If not specified, sortKey is removed.
               An alternative method to keep sortKey is to use -inplace
               option.

Options for “listify” and “tidy” actions:

-namespaces    Filter the arcitles in the specified namespaces. Separate
-namespace     multiple namespace numbers or names with commas. Examples::
-ns            -ns:0,2,4
               -ns:Help,MediaWiki

Options for “clean” action:

-always

Options for several actions:

-rebuild     - Reset the database.
-from:       - The category to move from (for the move option)
               Also, the category to remove from in the remove option
               Also, the category to make a list of in the listify option.
-to:         - The category to move to (for the move option).
             - Also, the name of the list to make in the listify option.
      NOTE: If the category names have spaces in them you may need to use
      a special syntax in your shell so that the names aren't treated as
      separate parameters. For instance, in BASH, use single quotes,
      e.g. -from:'Polar bears'.
-batch       - Don't prompt to delete emptied categories (do it
               automatically).
-summary:    - Pick a custom edit summary for the bot.
-inplace     - Use this flag to change categories in place rather than
               rearranging them.
-recurse[:<depth>]
             - Recurse through subcategories of the category to
               optional depth.
-pagesonly   - While removing pages from a category, keep the subpage links
               and do not remove them.
-match       - Only work on pages whose titles match the given regex (for
               move and remove actions).
-depth:      - The max depth limit beyond which no subcategories will be
               listed.

If action is “add”, the following additional options are supported:

This script supports use of pywikibot.pagegenerators arguments.

For the actions tidy and tree, the bot will store the category structure locally in category.dump. This saves time and server load, but if it uses these data later, they may be outdated; use the -rebuild parameter in this case.

For example, to create a new category from a list of persons, type:

python pwb.py category add -person

and follow the on-screen instructions.

Or to do it all from the command-line, use the following syntax:

python pwb.py category move -from:US -to:"United States"

This will move all pages in the category US to the category United States.

class scripts.category.CategoryAddBot(generator, newcat=None, sort_by_last_name=False, create=False, comment='', follow_redirects=False)

Bases: scripts.category.CategoryPreprocess

A robot to mass-add a category to a list of pages.

Parameters

• sort_by_last_name (bool) –

• create (bool) –

• comment (str) –

• follow_redirects (bool) –

Return type

None

sorted_by_last_name(catlink, pagelink)

Return a Category with key that sorts persons by their last name.

Parameters: catlink - The Category to be linked.

pagelink - the Page to be placed in the category.

Trailing words in brackets will be removed. Example: If category_name is ‘Author’ and pl is a Page to [[Alexandre Dumas (senior)]], this function will return this Category: [[Category:Author|Dumas, Alexandre]].

Return type

pywikibot.page._pages.Page

treat(page)

Process one page.

Return type

None

class scripts.category.CategoryDatabase(rebuild=False, filename='category.dump.bz2')

Bases: object

Temporary database saving pages and subcategories for each category.

This prevents loading the category pages over and over again.

Parameters

• rebuild (bool) –

• filename (str) –

Return type

None

dump(filename=None)

Save the dictionaries to disk if not empty.

Pickle the contents of the dictionaries superclass_db and cat_content_db if at least one is not empty. If both are empty, removes the file from the disk.

If the filename is None, it’ll use the filename determined in __init__.

Return type

None

get_articles(cat)

Return the list of pages for a given category.

Saves this list in a temporary database so that it won’t be loaded from the server next time it’s required.

Return type

Set[pywikibot.page._pages.Page]

get_subcats(supercat)

Return the list of subcategories for a given supercategory.

Saves this list in a temporary database so that it won’t be loaded from the server next time it’s required.

Return type

Set[pywikibot.page._pages.Category]

get_supercats(subcat)

Return the supercategory (or a set of) for a given subcategory.

Return type

Set[pywikibot.page._pages.Category]

property is_loaded: bool

Return whether the contents have been loaded.

rebuild()

Rebuild the dabatase.

Return type

None

class scripts.category.CategoryListifyRobot(cat_title, list_title, edit_summary, append=False, overwrite=False, show_images=False, *, talk_pages=False, recurse=False, prefix='*', namespaces=None)

Bases: object

Create a list containing all of the members in a category.

Parameters

• cat_title (Optional[str]) –

• list_title (Optional[str]) –

• edit_summary (str) –

• append (bool) –

• overwrite (bool) –

• show_images (bool) –

• talk_pages (bool) –

• recurse (Union[int, bool]) –

• prefix (str) –

Return type

None

run()

Start bot.

Return type

None

class scripts.category.CategoryMoveRobot(oldcat, newcat=None, batch=False, comment='', inplace=False, move_oldcat=True, delete_oldcat=True, title_regex=None, history=False, pagesonly=False, deletion_comment=0, move_comment=None, wikibase=True, allow_split=False, move_together=False, keep_sortkey=None)

Bases: scripts.category.CategoryPreprocess

Change or remove the category from the pages.

If the new category is given changes the category from the old to the new one. Otherwise remove the category from the page and the category if it’s empty.

Per default the operation applies to pages and subcategories.

Store all given parameters in the objects attributes.

Parameters

• oldcat – The move source.

• newcat – The move target.

• batch (bool) – If True the user has not to confirm the deletion.

• comment (str) – The edit summary for all pages where the category is changed, and also for moves and deletions if not overridden.

• inplace (bool) – If True the categories are not reordered.

• move_oldcat (bool) – If True the category page (and talkpage) is copied to the new category.

• delete_oldcat (bool) – If True the oldcat page and talkpage are deleted (or nominated for deletion) if it is empty.

• title_regex – Only pages (and subcats) with a title that matches the regex are moved.

• history (bool) – If True the history of the oldcat is posted on the talkpage of newcat.

• pagesonly (bool) – If True only move pages, not subcategories.

• deletion_comment (Union[int, str]) – Either string or special value: DELETION_COMMENT_AUTOMATIC: use a generated message, DELETION_COMMENT_SAME_AS_EDIT_COMMENT: use the same message for delete that is used for the edit summary of the pages whose category was changed (see the comment param above). If the value is not recognized, it’s interpreted as DELETION_COMMENT_AUTOMATIC.

• move_comment – If set, uses this as the edit summary on the actual move of the category page. Otherwise, defaults to the value of the comment parameter.

• wikibase (bool) – If True, update the Wikibase item of the old category.

• allow_split (bool) – If False only moves page and talk page together.

• move_together (bool) – If True moves the pages/subcategories only if page and talk page could be moved or both source page and target page don’t exist.

Return type

None

DELETION_COMMENT_AUTOMATIC = 0

DELETION_COMMENT_SAME_AS_EDIT_COMMENT = 1

static check_move(name, old_page, new_page)

Return if the old page can be safely moved to the new page.

Parameters

• name (str) – Title of the new page

• old_page (pywikibot.page.BasePage) – Page to be moved

• new_page (pywikibot.page.BasePage) – Page to be moved to

Returns

True if possible to move page, False if not page move not possible

Return type

bool

run()

The main bot function that does all the work.

For readability it is split into several helper functions: - _movecat() - _movetalk() - _hist() - _change() - _delete()

Return type

None

class scripts.category.CategoryPreprocess(follow_redirects=False, edit_redirects=False, create=False, **kwargs)

Bases: pywikibot.bot.BaseBot

A class to prepare a list of pages for robots.

Parameters

• follow_redirects (bool) –

• edit_redirects (bool) –

• create (bool) –

Return type

None

determine_template_target(page)

Return template page to be categorized.

Categories for templates can be included in <includeonly> section of template doc page.

Also the doc page can be changed by doc template parameter.

TODO: decide if/how to enable/disable this feature.

Parameters

page (pywikibot.Page) – Page to be processed.

Returns

Page to be categorized.

Return type

pywikibot.page._pages.Page

determine_type_target(page)

Return page to be categorized by type.

Parameters

page (pywikibot.Page) – Existing, missing or redirect page to be processed.

Returns

Page to be categorized.

Return type

Optional[pywikibot.page._pages.Page]

class scripts.category.CategoryTidyRobot(cat_title, cat_db, namespaces=None, comment=None)

Bases: pywikibot.bot.Bot, scripts.category.CategoryPreprocess

Robot to move members of a category into sub- or super-categories.

Specify the category title on the command line. The robot will pick up the page, look for all sub- and super-categories, and show them listed as possibilities to move page into with an assigned number. It will ask you to type number of the appropriate replacement, and performs the change robotically. It will then automatically loop over all pages in the category.

If you don’t want to move the member to a sub- or super-category, but to another category, you can use the ‘j’ (jump) command.

By typing ‘s’ you can leave the complete page unchanged.

By typing ‘m’ you can show more content of the current page, helping you to find out what the page is about and in which other categories it currently is.

Parameters

• cat_title (Optional[str]) – a title of the category to process.

• cat_db (CategoryDatabase object) – a CategoryDatabase object.

• namespaces (iterable of pywikibot.Namespace) – namespaces to focus on.

• comment (Optional[str]) – a custom summary for edits.

Return type

None

move_to_category(member, original_cat, current_cat)

Ask whether to move it to one of the sub- or super-categories.

Given a page in the original_cat category, ask the user whether to move it to one of original_cat’s sub- or super-categories. Recursively run through subcategories’ subcategories.

Note

current_cat is only used for internal recursion. You should always use current_cat = original_cat.

Parameters

• member (pywikibot.page._pages.Page) – a page to process.

• original_cat (pywikibot.page._pages.Category) – original category to replace.

• current_cat (pywikibot.page._pages.Category) – a category which is questioned.

Return type

None

teardown()

Cleanups after run operation.

Return type

None

treat(page)

Process page.

Return type

None

class scripts.category.CategoryTreeRobot(cat_title, cat_db, filename=None, max_depth=10)

Bases: object

Robot to create tree overviews of the category structure.

Parameters

• root. (* cat_title - The category which will be the tree's) –

• object. (* cat_db - A CategoryDatabase) –

• listed. (* max_depth - The limit beyond which no subcategories will be) – This also guarantees that loops in the category structure won’t be a problem.

• print (* filename - The textfile where the tree should be saved; None to) – the tree to stdout.

• max_depth (int) –

Return type

None

run()

Handle the multi-line string generated by treeview.

After string was generated by treeview it is either printed to the console or saved it to a file.

Return type

None

treeview(cat, current_depth=0, parent=None)

Return a tree view of all subcategories of cat.

The multi-line string contains a tree view of all subcategories of cat, up to level max_depth. Recursively calls itself.

Parameters

• opening. (* cat - the Category of the node we're currently) –

• tree (* current_depth - the current level in the) –

• from. (* parent - the Category of the category we're coming) –

• current_depth (int) –

Return type

str

class scripts.category.CleanBot(**kwargs)

Bases: pywikibot.bot.Bot

Automatically cleans up specified category.

Removes redundant grandchildren from specified category by removing direct link to grandparent.

In another words a grandchildren should not be also a children.

Stubs categories are exception.

New in version 7.0.

For details please read: https://en.wikipedia.org/wiki/WP:SUBCAT https://en.wikipedia.org/wiki/WP:DIFFUSE

Return type

None

skip_page(cat)

Check whether the category should be processed.

Return type

bool

treat(child)

Process the category.

Return type

None

update_options = {'recurse': False}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

scripts.category.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments.

Return type

None

category_redirect script

This bot will move pages out of redirected categories

The bot will look for categories that are marked with a category redirect template, take the first parameter of the template as the target of the redirect, and move all pages and subcategories of the category there. It also changes hard redirects into soft redirects, and fixes double redirects. A log is written under <userpage>/category_redirect_log. Only category pages that haven’t been edited for a certain cooldown period (currently 7 days) are taken into account.

The following parameters are supported:

-always           If used, the bot won't ask if it should add the specified
                  text

-delay:#          Set an amount of days. If the category is edited more recenty
                  than given days, ignore it. Default is 7.

-tiny             Only loops over Category:Non-empty_category_redirects and
                  moves all images, pages and categories in redirect categories
                  to the target category.

Usage:

python pwb.py category_redirect [options]

Note

This script is a ConfigParserBot. All options can be set within a settings file which is scripts.ini by default.

class scripts.category_redirect.CategoryRedirectBot(**kwargs)

Bases: pywikibot.bot.ConfigParserBot, pywikibot.bot.SingleSiteBot

Page category update bot.

Changed in version 7.0: CategoryRedirectBot is a ConfigParserBot

Return type

None

check_hard_redirect()

Check for hard-redirected categories.

Check categories that are not already marked with an appropriate softredirect template.

Return type

None

get_cat()

Specify the category page.

get_log_text()

Rotate log text and return the most recent text.

move_contents(old_cat_title, new_cat_title, edit_summary)

The worker function that moves pages out of oldCat into newCat.

Parameters

• old_cat_title (str) –

• new_cat_title (str) –

• edit_summary (str) –

Return type

Tuple[int, int]

ready_to_edit(cat)

Return True if cat not edited during cooldown period, else False.

run()

Run the bot.

Return type

None

teardown()

Write self.record to file and save logs.

Return type

None

update_options = {'delay': 7, 'tiny': False}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

scripts.category_redirect.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

change_pagelang script

This script changes the content language of pages

These command line parameters can be used to specify which pages to work on:

This script supports use of pywikibot.pagegenerators arguments.

Furthermore, the following command line parameters are supported:

-setlang          What language the pages should be set to

-always           If a language is already set for a page, always change it
                  to the one set in -setlang.

-never            If a language is already set for a page, never change it to
                  the one set in -setlang (keep the current language).

Note

This script is a ConfigParserBot. All options can be set within a settings file which is scripts.ini by default.

class scripts.change_pagelang.ChangeLangBot(**kwargs)

Bases: pywikibot.bot.ConfigParserBot, pywikibot.bot.SingleSiteBot

Change page language bot.

Changed in version 7.0: ChangeLangBot is a ConfigParserBot

Return type

None

changelang(page)

Set page language.

Parameters

page (pywikibot.page.BasePage) – The page to update and save

Return type

None

treat(page)

Treat a page.

Parameters

page (pywikibot.page.BasePage) – The page to treat

Return type

None

update_options = {'never': False, 'setlang': ''}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

scripts.change_pagelang.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

checkimages script

Script to check recently uploaded files

This script checks if a file description is present and if there are other problems in the image’s description.

This script will have to be configured for each language. Please submit translations as addition to the Pywikibot framework.

Everything that needs customisation is indicated by comments.

This script understands the following command-line arguments:

-limit              The number of images to check (default: 80)

-commons            The bot will check if an image on Commons has the same name
                    and if true it reports the image.

-duplicates[:#]     Checking if the image has duplicates (if arg, set how many
                    rollback wait before reporting the image in the report
                    instead of tag the image) default: 1 rollback.

-duplicatesreport   Report the duplicates in a log *AND* put the template in
                    the images.

-maxusernotify      Maximum notifications added to a user talk page in a single
                    check, to avoid email spamming.

-sendemail          Send an email after tagging.

-break              To break the bot after the first check (default: recursive)

-sleep[:#]          Time in seconds between repeat runs (default: 30)

-wait[:#]           Wait x second before check the images (default: 0)

-skip[:#]           The bot skip the first [:#] images (default: 0)

-start[:#]          Use allimages() as generator
                    (it starts already from File:[:#])

-cat[:#]            Use a category as generator

-regex[:#]          Use regex, must be used with -url or -page

-page[:#]           Define the name of the wikipage where are the images

-url[:#]            Define the url where are the images

-nologerror         If given, this option will disable the error that is risen
                    when the log is full.

Instructions for the real-time settings. For every new block you have to add:

<------- ------->

In this way the bot can understand where the block starts in order to take the right parameter.

• Name= Set the name of the block

• Find= search this text in the image’s description

• Findonly= search for exactly this text in the image’s description

• Summary= That’s the summary that the bot will use when it will notify the

  problem.

• Head= That’s the incipit that the bot will use for the message.

• Text= This is the template that the bot will use when it will report the

  image’s problem.

scripts.checkimages.CATEGORIES_WITH_LICENSES = ('Q4481876', 'Q7451504')

Category items with the licenses; subcategories may contain other licenses.

Changed in version 7.2: uses wikibase items instead of category titles.

class scripts.checkimages.CheckImagesBot(site, log_full_number=25000, sendemail_active=False, duplicates_report=False, log_full_error=True, max_user_notify=None)

Bases: object

A robot to check recently uploaded files.

Initializer, define some instance variables.

Parameters

• log_full_number (int) –

• sendemail_active (bool) –

• duplicates_report (bool) –

• log_full_error (bool) –

Return type

None

check_image_duplicated(duplicates_rollback)

Function to check the duplicated files.

Return type

bool

check_image_on_commons()

Checking if the file is on commons.

Return type

bool

check_step()

Check a single file page.

Return type

None

find_additional_problems()

Extract additional settings from configuration page.

Return type

None

ignore_save_related_errors = True

ignore_server_errors = False

static important_image(list_given)

Get tuples of image and time, return the most used or oldest image.

Parameters

list_given (List[Tuple[float, pywikibot.page._filepage.FilePage]]) – a list of tuples which hold seconds and FilePage

Returns

the most used or oldest image

Return type

pywikibot.page._filepage.FilePage

is_tagged()

Understand if a file is already tagged or not.

Return type

bool

load(raw)

Load a list of objects from a string using regex.

Return type

List[str]

load_hidden_templates()

Function to load the white templates.

Return type

None

load_licenses()

Load the list of the licenses.

Changed in version 7.2: return a set instead of a list for quicker lookup.

Return type

Set[pywikibot.page._pages.Page]

mini_template_check(template)

Check if template is in allowed licenses or in licenses to skip.

Return type

bool

put_mex_in_talk()

Function to put the warning in talk page of the uploader.

Return type

None

regex_generator(regexp, textrun)

Find page to yield using regex to parse text.

Return type

Generator[pywikibot.page._filepage.FilePage, None, None]

report(newtext, image_to_report, notification=None, head=None, notification2=None, unver=True, comm_talk=None, comm_image=None)

Function to make the reports easier.

Parameters

unver (bool) –

Return type

None

report_image(image_to_report, rep_page=None, com=None, rep_text=None, addings=True)

Report the files to the report page when needed.

Parameters

addings (bool) –

Return type

bool

set_parameters(image)

Set parameters.

Return type

None

skip_images(skip_number, limit)

Given a number of files, skip the first -number- files.

Return type

bool

smart_detection()

Detect templates.

The bot instead of checking if there’s a simple template in the image’s description, checks also if that template is a license or something else. In this sense this type of check is smart.

Return type

Tuple[str, bool]

tag_image(put=True)

Add template to the Image page and find out the uploader.

Parameters

put (bool) –

Return type

bool

takesettings()

Function to take the settings from the wiki.

Return type

None

template_in_list()

Check if template is in list.

The problem is the calls to the Mediawiki system because they can be pretty slow. While searching in a list of objects is really fast, so first of all let’s see if we can find something in the info that we already have, then make a deeper check.

Return type

None

upload_bot_change_function(report_page_text, upload_bot_array)

Detect the user that has uploaded the file through upload bot.

Return type

str

static wait(generator, wait_time)

Skip the images uploaded before x seconds.

Let the users to fix the image’s problem alone in the first x seconds.

Return type

Generator[pywikibot.page._filepage.FilePage, None, None]

exception scripts.checkimages.LogIsFull(arg)

Bases: pywikibot.exceptions.Error

Log is full and the bot cannot add other data to prevent Errors.

Parameters

arg (str) –

Return type

None

scripts.checkimages.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

bool

scripts.checkimages.print_with_time_zone(message)

Print the messages followed by the TimeZone encoded correctly.

Return type

None

claimit script

A script that adds claims to Wikidata items based on a list of pages

These command line parameters can be used to specify which pages to work on:

This script supports use of pywikibot.pagegenerators arguments.

Usage:

python pwb.py claimit [pagegenerators] P1 Q2 P123 Q456

You can use any typical pagegenerator (like categories) to provide with a list of pages. Then list the property–>target pairs to add.

For geographic coordinates:

python pwb.py claimit [pagegenerators] P625 [lat-dec],[long-dec],[prec]

[lat-dec] and [long-dec] represent the latitude and longitude respectively, and [prec] represents the precision. All values are in decimal degrees, not DMS. If [prec] is omitted, the default precision is 0.0001 degrees.

Example

python pwb.py claimit [pagegenerators] P625 -23.3991,-52.0910,0.0001

By default, claimit.py does not add a claim if one with the same property already exists on the page. To override this behavior, use the ‘exists’ option:

python pwb.py claimit [pagegenerators] P246 "string example" -exists:p

Suppose the claim you want to add has the same property as an existing claim and the “-exists:p” argument is used. Now, claimit.py will not add the claim if it has the same target, source, and/or the existing claim has qualifiers. To override this behavior, add ‘t’ (target), ‘s’ (sources), or ‘q’ (qualifiers) to the ‘exists’ argument.

For instance, to add the claim to each page even if one with the same property and target and some qualifiers already exists:

python pwb.py claimit [pagegenerators] P246 "string example" -exists:ptq

Note that the ordering of the letters in the ‘exists’ argument does not matter, but ‘p’ must be included.

class scripts.claimit.ClaimRobot(claims, exists_arg='', **kwargs)

Bases: pywikibot.bot.WikidataBot

A bot to add Wikidata claims.

Parameters

• claims (list) – A list of wikidata claims

• exists_arg (str) – String specifying how to handle duplicate claims

Return type

None

treat_page_and_item(page, item)

Treat each page.

Parameters

• page (pywikibot.page.BasePage) – The page to update and change

• item (pywikibot.page.ItemPage) – The item to treat

Return type

None

use_from_page = None

scripts.claimit.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

clean_sandbox script

This bot resets a (user) sandbox with predefined text

This script understands the following command-line arguments:

This script supports use of pywikibot.pagegenerators arguments.

Furthermore, the following command line parameters are supported:

-hours:#       Use this parameter if to make the script repeat itself
               after # hours. Hours can be defined as a decimal. 0.01
               hours are 36 seconds; 0.1 are 6 minutes.

-delay:#       Use this parameter for a wait time after the last edit
               was made. If no parameter is given it takes it from
               hours and limits it between 5 and 15 minutes.
               The minimum delay time is 5 minutes.

-text          The text that substitutes in the sandbox, you can use this
               when you haven't configured clean_candbox for your wiki.

-summary       Summary of the edit made by bot. Overrides the default
               from i18n.

This script is a ConfigParserBot. All local parameters can be given inside a scripts.ini file. Options passed to the script are priorized over options read from ini file.

See also

Supported .ini File Structure

For example:

[clean_sandbox]
# the parameter section for clean_sandbox script
summary = Bot: Cleaning sandbox
text = {{subst:Clean Sandbox}}
hours: 0.5
delay: 7

class scripts.clean_sandbox.SandboxBot(**kwargs)

Bases: pywikibot.bot.Bot, pywikibot.bot.ConfigParserBot

Sandbox reset bot.

Return type

None

available_options = {'delay': -1, 'hours': -1.0, 'summary': '', 'text': ''}

Handler configuration attribute. Only the keys of the dict can be passed as __init__ options. The values are the default values. Overwrite this in subclasses!

run()

Run bot.

Return type

None

scripts.clean_sandbox.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

commons_information script

Insert a language template into the description field

class scripts.commons_information.InformationBot(**kwargs)

Bases: pywikibot.bot.SingleSiteBot, pywikibot.bot.ExistingPageBot

Bot for the Information template.

Initialzer.

Return type

None

comment = {'en': 'Bot: wrap the description parameter of Information in the appropriate language template'}

desc_params = ('Description', 'description')

static detect_langs(text)

Detect language from griven text.

get_description(template)

Get description parameter.

lang_tmp_cat = 'Language templates'

process_desc_template(template)

Process description template.

Return type

bool

static replace_value(param, value)

Replace param with given value.

Return type

None

setup()

Raise exception if needed modules are missing.

treat_page()

Treat current page.

Return type

None

scripts.commons_information.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

commonscat script

With this tool you can add the template {{commonscat}} to categories

The tool works by following the interwiki links. If the template is present on another language page, the bot will use it.

You could probably use it at articles as well, but this isn’t tested.

The following parameters are supported:

-checkcurrent     Work on all category pages that use the primary commonscat
                  template.

This script is a ConfigParserBot. The following options can be set within a settings file which is scripts.ini by default::

-always           Don't prompt you for each replacement. Warning message
                  has not to be confirmed. ATTENTION: Use this with care!

-summary:XYZ      Set the action summary message for the edit to XYZ,
                  otherwise it uses messages from add_text.py as default.

This bot uses pagegenerators to get a list of pages. The following options are supported:

This script supports use of pywikibot.pagegenerators arguments.

For example to go through all categories:

python pwb.py commonscat -start:Category:!

class scripts.commonscat.CommonscatBot(**kwargs)

Bases: pywikibot.bot.ConfigParserBot, pywikibot.bot.ExistingPageBot

Commons categorisation bot.

Changed in version 7.0: CommonscatBot is a ConfigParserBot

Parameters

kwargs (Any) – bot options

Keyword Arguments

generator – a generator processed by run() method

Return type

None

changeCommonscat(page=None, oldtemplate='', oldcat='', newtemplate='', newcat='', linktitle='')

Change the current commonscat template and target.

Parameters

• oldtemplate (str) –

• oldcat (str) –

• newtemplate (str) –

• newcat (str) –

• linktitle (str) –

Return type

None

checkCommonscatLink(name='')

Return the name of a valid commons category.

If the page is a redirect this function tries to follow it. If the page doesn’t exists the function will return an empty string

Parameters

name (str) –

findCommonscatLink(page)

Find CommonsCat template on interwiki pages.

Returns

name of a valid commons category

Return type

str

find_commons_category(page)

Find CommonsCat template on Wikibase repository.

Use Wikibase property to get the category if possible. Otherwise check all langlinks to find it.

Returns

name of a valid commons category

Return type

str

static getCommonscatLink(page)

Find CommonsCat template on page.

Return type

tuple of (<templatename>, <target>, <linktext>, <note>)

static skipPage(page)

Determine if the page should be skipped.

Return type

bool

skip_page(page)

Skip category redirects.

treat_page()

Add CommonsCat template to page.

Take a page. Go to all the interwiki page looking for a commonscat template. When all the interwiki’s links are checked and a proper category is found add it to the page.

Return type

None

update_options = {'summary': ''}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

use_disambigs = False

Attribute to determine whether to use disambiguation pages. Set it to True to use disambigs only, set it to False to skip disambigs. If None both are processed.

New in version 7.2.

use_redirects = False

Attribute to determine whether to use redirect pages. Set it to True to use redirects only, set it to False to skip redirects. If None both are processed. For example to create a RedirectBot you may define:

class MyRedirectBot(ExistingPageBot):

    '''Bot who only works on existing redirects.'''

    use_redirects = True

New in version 7.2.

scripts.commonscat.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

coordinate_import script

Coordinate importing script

Usage:

python pwb.py coordinate_import -site:wikipedia:en \
    -cat:Category:Coordinates_not_on_Wikidata

This will work on all pages in the category “coordinates not on Wikidata” and will import the coordinates on these pages to Wikidata.

The data from the “GeoData” extension (https://www.mediawiki.org/wiki/Extension:GeoData) is used so that extension has to be setup properly. You can look at the [[Special:Nearby]] page on your local Wiki to see if it’s populated.

You can use any typical pagegenerator to provide with a list of pages:

python pwb.py coordinate_import -lang:it -family:wikipedia \
    -namespace:0 -transcludes:Infobox_stazione_ferroviaria

You can also run over a set of items on the repo without coordinates and try to import them from any connected page. To do this, you have to explicitly provide the repo as the site using -site argument. .. admonition:: Example

python pwb.py coordinate_import -site:wikidata:wikidata

-namespace:0 -querypage:Deadendpages

The following command line parameters are supported:

-always           If used, the bot won't ask if it should add the specified
                  text

-create           Create items for pages without one.

Note

This script is a ConfigParserBot. All options can be set within a settings file which is scripts.ini by default.

This script supports use of pywikibot.pagegenerators arguments.

class scripts.coordinate_import.CoordImportRobot(**kwargs)

Bases: pywikibot.bot.ConfigParserBot, pywikibot.bot.WikidataBot

A bot to import coordinates to Wikidata.

Changed in version 7.0: CoordImportRobot is a ConfigParserBot

Return type

None

has_coord_qualifier(claims)

Check if self.prop is used as property for a qualifier.

Parameters

claims (dict) – the Wikibase claims to check in

Returns

the first property for which self.prop is used as qualifier, or None if any

Return type

Optional[str]

item_has_coordinates(item)

Check if the item has coordinates.

Returns

whether the item has coordinates

Return type

bool

treat_page_and_item(page, item)

Treat page/item.

Return type

None

try_import_coordinates_from_page(page, item)

Try import coordinate from the given page to the given item.

Returns

whether any coordinates were found and the import was successful

Return type

bool

use_from_page = None

scripts.coordinate_import.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line argument

Return type

None

cosmetic_changes script

This module can do slight modifications to tidy a wiki page’s source code

The changes are not supposed to change the look of the rendered wiki page.

The following parameters are supported:

-always           Don't prompt you for each replacement. Warning (see below)
                  has not to be confirmed. ATTENTION: Use this with care!

-async            Put page on queue to be saved to wiki asynchronously.

-summary:XYZ      Set the summary message text for the edit to XYZ, bypassing
                  the predefined message texts with original and replacements
                  inserted.

-ignore:          Ignores if an error occurred and either skips the page or
                  only that method. It can be set to:
                  all - dos not ignore errors
                  match - ignores ISBN related errors (default)
                  method - ignores fixing method errors
                  page - ignores page related errors

The following generators and filters are supported:

This script supports use of pywikibot.pagegenerators arguments.

ATTENTION: You can run this script as a stand-alone for testing purposes. However, the changes that are made are only minor, and other users might get angry if you fill the version histories and watchlists with such irrelevant changes. Some wikis prohibit stand-alone running.

For further information see pywikibot/cosmetic_changes.py

class scripts.cosmetic_changes.CosmeticChangesBot(**kwargs)

Bases: pywikibot.bot.AutomaticTWSummaryBot, pywikibot.bot.ExistingPageBot

Cosmetic changes bot.

Parameters

kwargs (Any) – bot options

Keyword Arguments

generator – a generator processed by run() method

Return type

None

summary_key = 'cosmetic_changes-standalone'

Must be defined in subclasses.

treat_page()

Treat page with the cosmetic toolkit.

Changed in version 7.0: skip if InvalidPageError is raised

Return type

None

update_options = {'async': False, 'ignore': CANCEL.MATCH, 'summary': ''}

update_options can be used to update available_options; do not use it if the bot class is to be derived but use self.available_options.update(<dict>) initializer in such case.

New in version 6.4.

use_redirects = False

Attribute to determine whether to use redirect pages. Set it to True to use redirects only, set it to False to skip redirects. If None both are processed. For example to create a RedirectBot you may define:

class MyRedirectBot(ExistingPageBot):

    '''Bot who only works on existing redirects.'''

    use_redirects = True

New in version 7.2.

scripts.cosmetic_changes.main(*args)

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

Parameters

args (str) – command line arguments

Return type

None

dataextend script

Script to add properties, identifiers and sources to WikiBase items

Usage:

dataextend <item> [<property>[+*]] [args]

In the basic usage, where no property is specified, item is the Q-number of the item to work on.from html import unescape

If a property (P-number, or the special value ‘Wiki’ or ‘Data’) is specified, only the data from that identifier are added. With a ‘+’ after it, work starts on that identifier, then goes on to identifiers after that (including new identifiers added while working on those identifiers). With a ‘*’ after it, the identifier itself is skipped, but those coming after it (not those coming before it) are included.

The following parameters are supported:

-always    If this is supplied, the bot will not ask for permission
           after each external link has been handled.

-showonly  Only show claims for a given ItemPage. Don't try to add any
           properties

The bot will load the corresponding pages for these identifiers, and try to the meaning of that string for the specified type of thing (for example ‘city’ or ‘gender’). If you want to use it, but not save it (which can happen if the string specifies a certain value now, but might show another value elsewhere, or if it is so specific that you’re pretty sure it won’t occur a second time), you can provide the Q-number with X rather than Q. If you do not want to use the string, you can just hit enter, or give the special value ‘XXX’ which means that it will be skipped in each subsequent run as well.

After an identifier has been worked on, there might be a list of names that has been found, in lc:name format, where lc is a language code. You can accept all suggested names (answer Y), none (answer N) or ask to get asked for each name separately (answer S), the latter being the default if you do not fill in anything.

After all identifiers have been worked on, possible descriptions in various languages are presented, and you get to choose one. The default is here 0, which always is the current description for that language. Finally, for a number of identifiers text is shown that usually gives parts of the description that are hard to parse automatically, so you can see if there any additional pieces of data that can be added.

It is advisable to (re)load the item page that the bot has been working on in the browser afterward, to correct any mistakes it has made, or cases where a more precise and less precise value have both been included.

New in version 7.2.

class scripts.dataextend.AKLAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddescription(html)

findfirstname(html)

findinstanceof(html)

findlastname(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AbartAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

findgender(html)

findlanguagedescriptions(html)

findlongtext(html)

findnames(html)

findnationality(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AcademiaeGroninganaeAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddegrees(html)

finddescription(html)

findemployers(html)

findfirstname(html)

findgender(html)

findinstanceof(html)

findlastname(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

findschools(html)

getentry(naam, html, dtype=None)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AcademicTreeAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findadvisors(html)

findbirthdate(html)

finddeathdate(html)

finddescription(html)

finddocstudents(html)

findemployers(html)

findinstanceof(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findwebsite(html)

findworkfields(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AcademieFrancaiseAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findawards(html)

findlongtext(html)

findnames(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AcademieRouenAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddescription(html)

findfirstname(html)

findinstanceof(html)

findlastname(html)

findlongtext(html)

findmemberships(html)

findoccupations(html)

findresidences(html)

getvalue(field, html, dtype=None)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AccademiaCruscaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findinstanceof(html)

findlongtext(html)

findmemberships(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AdultFilmAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findethnicities(html)

findeyecolor(html)

findfloruitstart(html)

findhaircolor(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

getvalue(field, html, dtype=None)

getvalues(field, html, dtype=None)

Return type

List[str]

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AgorhaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddescription(html)

findgender(html)

findnames(html)

findnationality(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AinmAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

findgender(html)

findinstanceof(html)

findlongtext(html)

findnames(html)

findoccupations(html)

findschools(html)

getvalue(field, html, category=None)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AlkindiAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findfirstnames(html)

findgender(html)

findlanguagesspoken(html)

findlastname(html)

findmixedrefs(html)

findnames(html)

findnationality(html)

getvalue(field, html, dtype=None)

getvalues(field, html, dtype=None)

Return type

List[str]

instanceof(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AlvinAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findgender(html)

findinstanceof(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findnationalities(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AmericanArtAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

findincollections(html)

findlongtext(html)

findnames(html)

findnationalities(html)

findworkplaces(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AmericanBiographyAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddescription(html)

findfirstname(html)

findinstanceof(html)

findlastname(html)

findlongtext(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.Analyzer(id, data=None, item=None, bot=None)

Bases: object

SCRIPTRE = re.compile('(?s)<script.*?</script>', re.DOTALL)

TAGRE = re.compile('<[^<>]*>')

property alturl

static commastrip(term)

property extraurls: List[str]

findaddress(html)

findadminloc(html)

findadvisors(html)

findallbyre(regex, html, dtype=None, skips=None, alt=None)

Return type

list

findarchitects(html)

findartdirectors(html)

findawards(html)

findbaptismdate(html)

findbirthdate(html)

findbirthplace(html)

findbloodtype(html)

findbranches(html)

findburialdate(html)

findburialplace(html)

findbyre(regex, html, dtype=None, skips=None, alt=None)

Return type

str

findcast(html)

findcausedeath(html)

findchesstitle(html)

findchildren(html)

findchoriginplace(html)

findchoriginplaces(html)

findclaims()

findcoatarms(html)

findcolors(html)

findcomposers(html)

findconflicts(html)

findcoords(html)

findcostumedesigners(html)

findcountries(html)

findcountry(html)

findcrimes(html)

finddeathdate(html)

finddeathplace(html)

finddefaultmixedrefs(html, includesocial=True)

finddegrees(html)

finddescription(html)

finddescriptions(html)

finddevelopers(html)

finddirectorsphotography(html)

finddissolution(html)

finddistcoms(html)

finddocstudents(html)

finddurations(html)

findelevations(html)

findemployers(html)

findengines(html)

findethnicities(html)

findethnicity(html)

findeyecolor(html)

findfacebook(html)

findfacebookpage(html)

findfamily(html)

findfather(html)

findfeastday(html)

findfirstname(html)

findfirstnames(html)

findfloorsabove(html)

findfloorsbelow(html)

findfloruit(html)

findfloruitend(html)

findfloruitstart(html)

findformationlocation(html)

findfranchises(html)

findgamemodes(html)

findgender(html)

findgenres(html)

findgens(html)

findhaircolor(html)

findheight(html)

findheights(html)

findimage(html)

findinception(html)

findincollections(html)

findinfluences(html)

findinstanceof(html)

findinstruments(html)

findinworks(html)

findisni(html)

findisolations(html)

findkins(html)

findlabels(html)

findlanguagedescriptions(html)

findlanguagenames(html)

findlanguages(html)

findlanguagesspoken(html)

findlastname(html)

findlastnames(html)

findlocation(html)

findlogo(html)

findlongtext(html)

findmajors(html)

findmakeupartists(html)

findmannerdeath(html)

findmaterials(html)

findmemberships(html)

findmixedrefs(html)

findmother(html)

findmountainrange(html)

findmovements(html)

findmoviedirectors(html)

findmovieeditors(html)

findnames(html)

findnationalities(html)

findnationality(html)

findnativelanguages(html)

findnominations(html)

findnotableworks(html)

findoccupations(html)

findorientation(html)

findorigcountries(html)

findorigcountry(html)

findoriglanguages(html)

findparticipantins(html)

findparticipations(html)

findparties(html)

findpartners(html)

findpartofs(html)

findparts(html)

findpatronof(html)

findplatforms(html)

findpolitical(html)

findpositions(html)

findpremiere(html)

findprodcoms(html)

findproducers(html)

findproductiondesigners(html)

findprominences(html)

findpseudonyms(html)

findpubdate(html)

findpubdates(html)

findpublishers(html)

findranks(html)

findreligion(html)

findreligions(html)

findrelorder(html)

findresidences(html)

findschools(html)

findscreenwriters(html)

findsiblings(html)

findsignature(html)

findsounddesigners(html)

findsources(html)

findsportcountries(html)

findsports(html)

findsportteams(html)

findspouses(html)

findstudents(html)

findteachers(html)

findteampositions(html)

findtitles(html)

findtwitter(html)

finduse(html)

findviaf(html)

findvoice(html)

findvoices(html)

findwebpages(html)

findwebsite(html)

findweight(html)

findweights(html)

findwikipedianames(html)

findworkfields(html)

findworkplaces(html)

getdata(dtype, text, ask=True)

getdescriptions()

getlanguage(code)

getnames()

longtext()

prepare(html)

setup()

To be used for putting data into subclasses.

static singlespace(text)

property url

class scripts.dataextend.AngelicumAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findgender(html)

findlanguagesspoken(html)

findmixedrefs(html)

findnames(html)

findnationalities(html)

instanceof(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AnimeConsAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

finalscript(html)

finddescription(html)

findinstanceof(html)

findlongtext(html)

findnames(html)

findnationality(html)

findoccupations(html)

findwebsite(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArchivesDuSpectacleAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddescription(html)

findgender(html)

findinstanceof(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArmbAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findassociations(html)

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findlongtext(html)

findmemberships(html)

findnames(html)

findworkfields(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArtHistoriansAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddescription(html)

findfirstname(html)

findinstanceof(html)

findlastname(html)

findlongtext(html)

findnames(html)

findnationality(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArtUkAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findincollections(html)

findnames(html)

findnationalities(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArtcyclopediaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddescription(html)

findincollections(html)

findinstanceof(html)

findlongtext(html)

findmovements(html)

findnames(html)

findnationality(html)

prepare(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArticArtistAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddescriptions(html)

findincollections(html)

findinstanceof(html)

findlongtext(html)

findnames(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArtistsCanadaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

findfirstname(html)

findgender(html)

findinstanceof(html)

findlastname(html)

findnames(html)

findnationality(html)

findoccupations(html)

findresidences(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ArtnetAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddescription(html)

findincollections(html)

findinstanceof(html)

findlongtext(html)

findmemberships(html)

findnames(html)

findnationalities(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AthenaeumAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddescription(html)

findgender(html)

findincollections(html)

findlongtext(html)

findnames(html)

findnationality(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AustrianBiographicalAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescriptions(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AuteursLuxembourgAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findlongtext(html)

findnames(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.AutoresArAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescriptions(html)

findfirstname(html)

findgender(html)

findinstanceof(html)

findlastname(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

getvalue(field, html, dtype=None)

prepare(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BabelioAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findinstanceof(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findnationality(html)

findwebsite(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BacklinkAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findadvisors(html)

findawards(html)

findchildren(html)

finddocstudents(html)

findkins(html)

findlongtext(html)

findmixedrefs(html)

findparticipantins(html)

findpartners(html)

findpartofs(html)

findparts(html)

findpositions(html)

findsiblings(html)

findsources(html)

findspouses(html)

findstudents(html)

findteachers(html)

getrelations(relation, html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BandcampAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findlongtext(html)

findmixedrefs(html)

findnames(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BdelAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddescription(html)

findfirstname(html)

findgender(html)

findlastname(html)

findmixedrefs(html)

findnames(html)

findnationality(html)

findoccupations(html)

findparties(html)

findranks(html)

getvalue(field, html, dtype=None)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BdfaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

findheight(html)

findlongtext(html)

findnames(html)

findnationality(html)

findsportteams(html)

findteampositions(html)

findweight(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BedethequeAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findfirstname(html)

findinstanceof(html)

findlastname(html)

findlongtext(html)

findnames(html)

findnationality(html)

findpseudonyms(html)

findwebsite(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BelgianPhotographerAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

findgender(html)

findgenres(html)

findinstanceof(html)

findlongtext(html)

findmemberships(html)

findnames(html)

findoccupations(html)

findworkplaces(html)

getvalue(field, html, dtype=None, alt=None)

getvalues(field, html, dtype=None, alt=None)

Return type

List[str]

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BenezitAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findfirstname(html)

findgender(html)

findisntanceof(html)

findlastname(html)

findlongtext(html)

findnames(html)

findnationality(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BenezitUrlAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.UrlAnalyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findfirstname(html)

findgender(html)

findisntanceof(html)

findlastname(html)

findlongtext(html)

findnames(html)

findnationality(html)

findoccupations(html)

indinstanceof(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BewebAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescriptions(html)

findgender(html)

findinstanceof(html)

findisni(html)

findlanguagenames(html)

findlongtext(html)

findmixedrefs(html)

findnationalities(html)

findoccupations(html)

findpositions(html)

findviaf(html)

findwebpages(html)

getvalue(field, html, dtype=None)

getvalues(field, html, dtype=None)

Return type

List[str]

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BibliotecaNacionalAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.UrlAnalyzer

findbirthplace(html)

finddeathplace(html)

findgender(html)

findlanguagesspoken(html)

findnames(html)

findoccupations(html)

findworkfields(html)

getvalue(field, html, dtype=None)

getvalues(field, html, dtype=None)

Return type

List[str]

prepare(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BibsysAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findfirstname(html)

findinstanceof(html)

findisni(html)

findlastname(html)

findnames(html)

findviaf(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BiografischPortaalAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findgender(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findsources(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BiuSanteAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BnaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findgender(html)

findlanguagesspoken(html)

findlongtext(html)

findmemberships(html)

findnames(html)

findoccupations(html)

findworkfields(html)

getvalue(field, html, dtype=None)

getvalues(field, html, dtype=None)

Return type

List[str]

instanceof(html)

prepare(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BnbAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddescription(html)

findfirstname(html)

findinstanceof(html)

findisni(html)

findlastname(html)

findnames(html)

findviaf(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BneAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescriptions(html)

findfirstname(html)

findisni(html)

findlanguagesspoken(html)

findlastname(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

findviaf(html)

findworkfields(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BnfAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

findcountry(html)

finddeathdate(html)

finddeathplace(html)

finddescriptions(html)

findemployers(html)

findgender(html)

findinstanceof(html)

findisni(html)

findlanguagesspoken(html)

findlongtext(html)

findnames(html)

findnationality(html)

findoccupations(html)

findworkfields(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BookTradeAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

finddeathdate(html)

findfloruit(html)

findlongtext(html)

findnames(html)

findoccupations(html)

findworkplaces(html)

getvalue(field, html, dtype=None)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BritishExecutionsAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findcausedeath(html)

findcrimes(html)

finddeathdate(html)

finddeathplace(html)

findgender(html)

findinstanceof(html)

findlongtext(html)

findmannerdeath(html)

findnames(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BritishMuseumAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

finddetails(html)

findgender(html)

findinstanceof(html)

findlongtext(html)

findnames(html)

findnationalities(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.BrooklynMuseumAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.UrlAnalyzer

findbirthdate(html)

finddeathdate(html)

findincollections(html)

findlongtext(html)

findnames(html)

findnationality(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CageMatchAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthplace(html)

findgender(html)

findheight(html)

findlanguagenames(html)

findlongtext(html)

findmixedrefs(html)

findoccupations(html)

findsports(html)

findweights(html)

getvalue(field, html, dtype=None)

getvalues(field, html, dtype=None)

Return type

List[str]

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CanadianBiographyAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findfather(html)

findlongtext(html)

findmother(html)

findnames(html)

findspouses(html)

prepare(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CanticAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.MarcAnalyzer

finddescriptions(html)

findlongtext(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CbdbAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findlanguagenames(html)

findlongtext(html)

findnationalities(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CcedAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddegrees(html)

findfirstname(html)

findinstanceof(html)

findlastname(html)

findlongtext(html)

findnames(html)

findoccupations(html)

findpositions(html)

findreligion(html)

findschools(html)

findworkplaces(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CerlAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

findchildren(html)

finddeathdate(html)

finddeathplace(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findnationality(html)

findoccupations(html)

findworkplaces(html)

getvalue(field, html, dtype=None)

getvalues(field, html, dtype=None, link=False)

Return type

List[str]

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CesarAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findfirstname(html)

findgender(html)

findlastname(html)

findnames(html)

findnationality(html)

findoccupations(html)

getvalue(field, html, dtype=None)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.Chess365Analyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findchesstitle(html)

findgender(html)

findmixedrefs(html)

findnames(html)

findnationalities(html)

findparticipations(html)

findsportcountries(html)

findsports(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CinemagiaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddescription(html)

findlongtext(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CiniiAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findfirstname(html)

findinstanceof(html)

findlastname(html)

findnames(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ClaraAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findgender(html)

findinstanceof(html)

findlongtext(html)

findnames(html)

findnationality(html)

findoccupations(html)

findresidences(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CommonwealthGamesAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findgender(html)

findinstanceof(html)

findnames(html)

findnationalities(html)

findparticipations(html)

findsports(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ConorAlAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.ConorAnalyzer

findbirthdate(html)

finddeathdate(html)

findfirstname(html)

findlanguagesspoken(html)

findlastname(html)

findnationality(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ConorAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findinstanceof(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ConorBgAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.ConorAnalyzer

finddescription(html)

findfirstnames(html)

findlanguagesspoken(html)

findlastnames(html)

findnames(html)

findnationality(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ConorSiAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.ConorAnalyzer

findbirthdate(html)

finddeathdate(html)

finddescription(html)

findfirstname(html)

findlanguagesspoken(html)

findlastname(html)

findnames(html)

findnationalities(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.ConorSrAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.ConorAnalyzer

finddescription(html)

findfirstnames(html)

findlanguagesspoken(html)

findlastnames(html)

findnames(html)

findnationality(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CsfdAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

findlongtext(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CthsAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findfirstname(html)

findlastname(html)

findlongtext(html)

findmemberships(html)

findnames(html)

findoccupations(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.CwaAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findawards(html)

findinstanceof(html)

findmixedrefs(html)

findnames(html)

findoccupations(html)

findwebsite(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.DaaoAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

findbirthplace(html)

finddeathdate(html)

finddeathplace(html)

finddescription(html)

findgender(html)

findinstanceof(html)

findlanguagesspoken(html)

findlongtext(html)

findnames(html)

findoccupations(html)

findresidences(html)

getvalue(field, html, dtype=None)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.DacsAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findbirthdate(html)

finddeathdate(html)

findfirstname(html)

findlastname(html)

findlongtext(html)

findnames(html)

findnationalities(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.DanskefilmAnalyzer(id, data=None, item=None, bot=None)

Bases: scripts.dataextend.Analyzer

findawards(html)

findbirthdate(html)

findbirthplace(html)

findburialplace(html)

finddeathdate(html)

finddeathplace(html)

finddescriptions(html)

findlongtext(html)

findnames(html)

setup()

To be used for putting data into subclasses.

class scripts.dataextend.DataExtendBot(**kwargs)

Bases: pywikibot.bot.SingleSiteBot

MONTHNUMBER = {'01': 1, '02': 2, '03': 3, '04': 4, '05': 5, '06': 6, '07': 7, '08': 8,