python-mwapi 0.2

简介

此库提供了一种非常简单的便利封装，用于围绕Mediawiki API。它旨在与Mediawiki API提供的界面紧密对应

功能

该库允许您调用Mediawiki API，而无需处理网络调用。它还支持身份验证和几个便利方法。

非功能

这是反mwclient。它不会为您添加另一个理解良好的Mediawiki API的层，而且永远不会：）

文档

MWApi

class MWApi

表示单个API会话的类，具有单个已验证用户。

有用的属性

tokens - 包含edittoken & watchtoken（如果已调用populateTokens()）

is_authenticated - 布尔值，指示MWApi是否发送已验证请求

在此定义的方法

__init__(self, host, api_path=’/w/api.php’)

创建MWApi实例

参数

host - 要连接的主机。必须包含 http:// 或 https://，且不允许有尾随斜杠

api_path - 主机上的api.php的URL。必须以/开头

get(self, params)

使用GET方法进行API请求

参数

params - 发送到API的参数。具体取决于要执行的操作。

login(self, username, password)

使用给定的凭据进行身份验证并登录用户会话。

从该MWApi对象发送的所有后续请求都将作为该用户签名。

参数

username - 要进行身份验证的用户名

password - 要进行身份验证的密码

抛出异常

如果身份验证失败，则抛出包含（消息，响应）的异常

注意

密码以明文形式发送。这是Mediawiki API的限制。

如果您想使密码安全，请使用https主机

populateTokens(self)

使用< cite >edittoken和< cite >watchtoken填充对象的< cite >tokens属性。

要求已经使用< cite >login()执行了身份验证

post(self, params)

使用POST方法进行API请求

参数

params - 发送到API的参数。具体取决于要执行的操作。

request(self, method, params)

对API进行请求并返回包含结果的字典

参数

method - 根据正在调用的API是GET还是POST

params - 发送到API的参数。具体取决于要执行的操作。

联系方式

支持请求和批评可以通过多种方式发送给我。

电子邮件：yuvipanda@gmail.com。推特：@yuvipanda。IRC：FreeNode上的yuvipanda

您可以在Github上提交错误。