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)
例子
文档互转
嵌入
在服务器上运行
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.6.tar.gz
(6.1 MB
view hashes)
Built Distributions
Close
Hashes for pywpsrpc-2.3.6-cp311-cp311-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16a50b27b396d772307a08f06eba2c5de58c02c53ee123f91e9977608a9f360c |
|
MD5 | 5e3dd8c12615192d923b20f46083c57c |
|
BLAKE2b-256 | af949f8fa5d3edde4568d0d2ad49a11826503aad60905e0301b3ce74f954f13a |
Close
Hashes for pywpsrpc-2.3.6-cp310-cp310-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17f5cd56e286cf13a779d1f67123458620ae254f93d0e4ee5922f9e881e0190c |
|
MD5 | 84a1e3f9770d935b5bf1c38edee13b78 |
|
BLAKE2b-256 | da3074ba7313ccb3ac53542d79a77ac90abc0741fd9e298c0107a84be74b5bd3 |
Close
Hashes for pywpsrpc-2.3.6-cp39-cp39-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e014c934b65dc6fd3f557605f8122f13dcd013b18318f2448114b6bc7178675a |
|
MD5 | f6ddcfdf7fad059605aabbc5849e9ac9 |
|
BLAKE2b-256 | d89f4a65463fe74c0db058ffcf90a213199184d0bc2187dec9482fce045b74c3 |
Close
Hashes for pywpsrpc-2.3.6-cp38-cp38-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e57cf0e487bf99bc0376e52dcdb9b593482902c25ecf6bc6d00672f5a8e26e4f |
|
MD5 | 4f0b950726910b71cae730655528b47c |
|
BLAKE2b-256 | 573fbac269e9bc2d0c0bc2b64631235555903ee8b4bc35d2f5a1a1d9956ed1b3 |
Close
Hashes for pywpsrpc-2.3.6-cp37-cp37m-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c2ea69620281c3f3f68316dac6ce8e9879ce0efd3153b3ee0b1a3a9dea35925 |
|
MD5 | 7091c49048bed781b3568ad2955db605 |
|
BLAKE2b-256 | eef1169c8fe2bf489f7979d2b1e22c38b66ae5e67c0c8f82adc2bc0ce37f6c6b |
Close
Hashes for pywpsrpc-2.3.6-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b1bd4adc7e06e3dfdf554960e842c710d8dcef1ae4bbdc655ab678573ac104a |
|
MD5 | 7a791a73ee1a1c0716eaea999330266e |
|
BLAKE2b-256 | 05a93cb151296007a318fbd24bbe87aa7e51e71ed0c750948be4bb9d63568510 |