Module pywikipedia.wikipedia

Library to get and put pages on a MediaWiki.

Contents of the library (objects and functions to be used outside, situation
late August 2004)

Classes:
Page: A MediaWiki page
    __init__: Page(xx,Title) - the page with title Title on language xx:
    linkname: The name of the page, in a form suitable for an interwiki link
    urlname: The name of the page, in a form suitable for a URL
    catname: The name of the page, with the namespace part removed
    section: The section of the page (the part of the name after '#')
    sectionFreeLinkname: The name without the section part
    aslink: The name of the page in the form [[Title]] or [[lang:Title]]
    site: The wiki where this page is in
    encoding: The encoding the page is in

    get (*): The text of the page
    exists (*): True if the page actually exists, false otherwise
    isRedirectPage (*): True if the page is a redirect, false otherwise
    isEmpty (*): True if the page has 4 characters or less content, not
        counting interwiki and category links
    interwiki (*): The interwiki links from the page (list of Pages)
    categories (*): The categories the page is in (list of Pages)
    rawcategories (*): Like categories, but if the link contains a |, the
        part after the | is included.
    linkedPages (*): The normal pages linked from the page (list of Pages)
    imagelinks (*): The pictures on the page (list of strings)
    templates(*): All templates referenced on the page (list of strings)
    getRedirectTarget (*): The page the page redirects to
    isCategory: True if the page is a category, false otherwise
    isImage: True if the page is an image, false otherwise
    isDisambig (*): True if the page is a disambiguation page
    getReferences: The pages linking to the page
    namespace: The namespace in which the page is

    put(newtext): Saves the page
    delete: Deletes the page (requires being logged in)

    (*): This loads the page if it has not been loaded before

Other functions:
getall(xx,Pages): Get all pages in Pages (where Pages is a list of Pages,
    and xx: the language the pages are on)
setAction(text): Use 'text' instead of "Wikipedia python library" in
    summaries
allpages(): Get all page titles in one's home language as Pages (or all
    pages from 'Start' if allpages(start='Start') is used).
checkLogin(): gives True if the bot is logged in on the home language, False
    otherwise
argHandler(text): Checks whether text is an argument defined on wikipedia.py
    (these are -family, -lang, and -log)
translate(xx, dict): dict is a dictionary, giving text depending on language,
    xx is a language. Returns the text in the most applicable language for
    the xx: wiki

output(text): Prints the text 'text' in the encoding of the user's console.
input(text): Asks input from the user, printing the text 'text' first.
showDiff(oldtext, newtext): Prints the differences between oldtext and newtext
    on the screen

getLanguageLinks(text,xx): get all interlanguage links in wikicode text 'text'
    in the form xx:pagename
removeLanguageLinks(text): gives the wiki-code 'text' without any interlanguage
    links.
replaceLanguageLinks(oldtext, new): in the wiki-code 'oldtext' remove the
    language links and replace them by the language links in new, a dictionary
    with the languages as keys and either Pages or linknames as values
getCategoryLinks(text,xx): get all category links in text 'text' (links in the
    form xx:pagename)
removeCategoryLinks(text,xx): remove all category links in 'text'
replaceCategoryLinks(oldtext,new): replace the category links in oldtext by
    those in new (new a list of category Pages)
stopme(): Put this on a bot when it is not or not any more communicating
    with the Wiki. It will remove the bot from the list of running processes,
    and thus not slow down other bot threads any more.

Imported modules:

codecs, pywikipedia.config, datetime, difflib, htmlentitydefs, httplib, locale, math, pywikipedia.mediawiki_messages, os, re, socket, sys, time, traceback, urllib, warnings, xml

Imported classes:

set, SaxError

Imported variables:

__version__, action, edittime, generators, get_throttle, put_throttle, Rmorespaces, Rmoreunderlines, _sites

Get the contents of page 'name' from the 'site' wiki
Do not use this directly; for 99% of the possible ideas you can
use the Page object instead.

Arguments:
    site          - the wiki site
    name          - the page name
    read_only     - If true, doesn't raise LockedPage exceptions.
    do_quote      - ??? (TODO: what is this for?)
    get_redirect  - Get the contents, even if it is a redirect page

This routine returns a unicode string containing the wiki text.