aiowiki package

Submodules

aiowiki.exceptions module

exception aiowiki.exceptions.PageNotFound

Bases: Exception

Exception raised when a page does not exist

exception aiowiki.exceptions.LoginFailure

Bases: Exception

Exception raised when a login() fails

exception aiowiki.exceptions.BadWikiUrl

Bases: Exception

Exception raised when the URL of the Wiki() is not in the standard Wikimedia API format

exception aiowiki.exceptions.TokenGetError

Bases: Exception

Exception raised when the internal acquiring for a token fails

exception aiowiki.exceptions.CreateAccountError

Bases: Exception

Exception raised when create_account() fails

exception aiowiki.exceptions.EditError

Bases: Exception

Exception raised when edit() fails

exception aiowiki.exceptions.NoSuchUserError

Bases: Exception

Exception raised when userrights() fails because the target user does not exist

exception aiowiki.exceptions.InvalidGroupError

Bases: Exception

Exception raised when userrights() fails because the selected group for adding to does not exist

exception aiowiki.exceptions.UserRightsNotChangedError

Bases: Exception

Exception raised when userrights() fails for several reasons

aiowiki.http module

class aiowiki.http.HTTPClient(url, session, logged_in)

Bases: object

A Proxy object for all API actions

coroutine close()

Closes the aiohttp Session

coroutine get_token(type)

Gets an API token

coroutine get_random_pages(num, namespace)

Gets random page names

coroutine create_account(json)

Creates an account

coroutine userrights(json)

Manage user rights

coroutine login(json)

Logs in to the wiki

coroutine get_html(page)

Gets Page html

coroutine get_markdown(page)

Gets Page markdown

coroutine get_summary(page)

Gets Page summary

coroutine edit_page(json)

Edits a page’s content

coroutine opensearch(title, limit, namespace)

Searches for a page title and returns limit results as a list

coroutine get_urls(title)

Searches for URLs matching a title and returns edit URL and page URL in a list

coroutine get_media(title)

Searches for media on a specific page and returns a list of URLs

aiowiki.page module

class aiowiki.page.Page(page_title, wiki)

Bases: object

Represents a Page in the Wiki(). This is usually acquired by get_page() or other methods, and not created directly.

Parameters

• page_title (str) – The title of the page.

• wiki (Wiki) – The Wiki() object this page belongs to.

Variables

• title – The page title

• wiki – The Wiki() it belongs to

coroutine html()

The pure page HTML.

coroutine markdown()

The Markdown version of the page content.

coroutine text()

The text of the page without HTML tags.

coroutine summary()

The summary of the page, usually the first paragraph.

coroutine urls()

A namedtuple representing the view and edit URL for the page.

coroutine media()

Returns a list of all media used on the page.

coroutine edit(content: str)

Edits the page.

aiowiki.wiki module

class aiowiki.wiki.Wiki(base_url: str, session: Optional[aiohttp.client.ClientSession] = None)

Bases: object

Represents a Mediawiki and is the main entry class to the library.

Parameters

• base_url (str) – The api.php endpoint of your Wiki

• session (aiohttp.ClientSession or None) – An opional aiohttp.ClientSession to use for the internal Wiki HTTP operations. Leaving this empty will automatically create one.

Variables

• http – A HTTPClient() for the Wiki

• url – The API Url for the Wiki

classmethod wikipedia(language='en', *args, **kwargs)

coroutine close()

Close the aiohttp Session

coroutine get_token(type: str = 'csrf')

Get an API token for a login attempt.

coroutine get_random_pages(num: int = 1, namespace: str = '*')

Gets a list of random Page objects

coroutine create_account(username: str, password: str, email: Optional[str] = None, real_name: Optional[str] = None)

Creates an account in the wiki. May fail if captchas are required.

coroutine userrights(username: str, action: str, group: str)

Update user rights of ‘username’, action: add or remove. Can add or remove many groups with sep groups name by ‘|’. ex: username: ‘my_id’, action: ‘add’, group: ‘bureaucrat|bot’

coroutine login(username: str, password: str)

Logs in to the wiki.

get_page(page_title: str)

Retrieves a page from the wiki. Returns a Page object.

coroutine opensearch(search_query: str, limit: int = 10, namespace: str = '0')

Returns limit Page objects matching the query

Module contents