Python bindings for the WPS Office RPC
Project description
pywpsrpc
WPS Office for Linux二次开发C++接口Python绑定.
Read this in other languages: English
WPS Office二次开发接口
WPS二次开发接口允许开发者通过给定的接口来调起WPS并执行指定的任务, 比如你可以打开、编辑然后保存文档,转换文档格式等文档自动化操作,又或者将WPS嵌入到自己的程序、进行功能扩展等。
关于详细的接口文档,可参考
- WPS官方的开发网站 https://open.wps.cn/docs/client/wpsLoad
- VBA官方文档 https://docs.microsoft.com/en-us/office/vba/api/overview/
对于pywpsrpc本身的文档,可跳转到wiki查看。
依赖
- Python 3.6+
- Qt5 (C++ SDK依赖)
- WPS Office for Linux 11.1.0.9080+
- sip 6.0+ (仅编译)
- qmake (仅编译)
- g++ (仅编译)
- 桌面环境(WPS运行需要)
PS,目前WPS整合模式有BUG,非把WPS嵌入到自己进程的场景建议先切换到多组件模式
如何编译
在项目顶层目录下运行终端执行: sip-build
如果需要查看编译相关输出信息,可添加 --verbose 选项
安装
建议通过PyPi安装:
pip install pywpsrpc
如果默认的源太慢,建议自行搜索添加中国pip源
通过源码编译安装:
先打包执行: sip-wheel
打包完成后再通过pip install pywpsrpc-*.whl
命令安装
快速上手
# 第一步先import所需模块(rpcxxxapi,xxx为对应项目的名字)
# rpcwpsapi模块为WPS文字项目的开发接口
# rpcwppapi则是WPS演示的
# rpcetapi毫无疑问就是WPS表格的了
# 另外还有common模块,为前三者的公共接口模块,通常不能单独使用
# 调起WPS必需通过createXXXRpcInstance接口,所以导入它是必需的
# 以WPS文字为例
from pywpsrpc.rpcwpsapi import (createWpsRpcInstance, wpsapi)
from pywpsrpc import RpcIter
# 这里仅创建RPC实例
hr, rpc = createWpsRpcInstance()
# 注意:
# WPS开发接口的返回值第一个总是HRESULT(无返回值的除外)
# 通常不为0的都认为是调用失败(0 == common.S_OK)
# 可以使用common模块里的FAILED或者SUCCEEDED去判断
# 通过rpc实例调起WPS进程
hr, app = rpc.getWpsApplication()
# 比如添加一个空白文档
hr, doc = app.Documents.Add()
# 加点文字
selection = app.Selection
selection.InsertAfter("Hello, world")
# 将前面插入的"Hello, world"加粗
selection.Font.Bold = True
# 光标移到末尾
selection.EndKey()
# 再插入空段
selection.InsertParagraph()
# 光标移到新段
selection.MoveDown()
# 再码些文字
selection.TypeText("pywpsrpc~")
# 使用RpcIter遍历所有段
paras = doc.Paragraphs
for para in RpcIter(paras):
print(para.Range.Text)
# 或者通过索引方式
for i in range(0, paras.Count):
# 注意:首个元素总是从1开始
print(paras[i + 1].OutlineLevel)
def onDocumentBeforeSave(doc):
# 如果想取消当前文档保存,第二个返回值设为True
print("onDocumentBeforeSave called for doc: ", doc.Name)
# SaveAsUI, Cancel
return True, False
# 注册文档保存前通知
rpc.registerEvent(app,
wpsapi.DIID_ApplicationEvents4,
"DocumentBeforeSave",
onDocumentBeforeSave)
# 保存文档, onDocumentBeforeSave会被调用到
doc.SaveAs2("test.docx")
# 退出WPS进程
# 使用wpsapi.wdDoNotSaveChanges来忽略文档改动
app.Quit(wpsapi.wdDoNotSaveChanges)
例子
文档互转
嵌入
在服务器上运行
关于授权
pywpsrpc为MIT开源授权协议,项目本身允许商用,但前提是你所使用的WPS Office For Linux版本允许商用(目前个人版本即社区版本不允许),具体需要联系WPS官方咨询。对于不在合理范围使用本项目的,本项目不承担任何法律责任。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pywpsrpc-2.3.8.tar.gz
(6.1 MB
view hashes)
Built Distributions
Close
Hashes for pywpsrpc-2.3.8-cp311-cp311-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7889c631437c68dbb69649dac3ef6ff4b2a0561a50181c246fb9f3765eb1ab90 |
|
MD5 | f7369ed83630026efd2e0fc66f7c575b |
|
BLAKE2b-256 | 7d2325f889b73ffa96fe35b868c6abd5a3089c3bc165eaddb29c5529e1888068 |
Close
Hashes for pywpsrpc-2.3.8-cp310-cp310-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c007b027d137c445293748d283ff5d62bce81d0f17808bb0b25202d19e9aa666 |
|
MD5 | 5c41d487995929c82549a11d7ede6b15 |
|
BLAKE2b-256 | e32b7ba893d8af22669d74fbbefb52c2ab8762b5c4fcbe6931a6159aa664162b |
Close
Hashes for pywpsrpc-2.3.8-cp39-cp39-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3373a07ed3f3b2380566a5cfc3b92d830db8a50ea96f5f67c58fa017c91a5fb |
|
MD5 | 3eeb7bd97258f9b328f71c7a25912595 |
|
BLAKE2b-256 | 35496c7082adeb3e8f270b80e06e9fb0c333805b965d1fabb4b9ecf23787625d |
Close
Hashes for pywpsrpc-2.3.8-cp38-cp38-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec84489fa1998647cc659ed75fe3ce8f42c49f61dc32b00d362c2f3a615b213b |
|
MD5 | 2b7e00e522dfe64b2fadb13f1fcdbc02 |
|
BLAKE2b-256 | f7b59d7dc0eb4f4a742eddfecc8f5b21dbe1017b528b918298f2925c1a25c112 |
Close
Hashes for pywpsrpc-2.3.8-cp37-cp37m-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7574e67152c498308ecbc3e0c21fe17d42d2bc3161d013ed7045ac151d8798e1 |
|
MD5 | 8af5282373bce64a041cf39f2fe0d4df |
|
BLAKE2b-256 | ed0b0056ae92f16d97f64eb9096e5874b09ff7e184676314da6ba8eb26d94862 |
Close
Hashes for pywpsrpc-2.3.8-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0c59e2a5880019b118d7efe283477d50f039bb08b6f05c1fe9541482e744887 |
|
MD5 | 45f68993207acbd91026e44712f252f0 |
|
BLAKE2b-256 | d9c50afc5d5090c0b7bcae1e22ebc5043225ac1faa15102bf613c2d3fa84828c |