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.7.tar.gz
(6.1 MB
view hashes)
Built Distributions
Close
Hashes for pywpsrpc-2.3.7-cp311-cp311-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bbfcf7fce7ca90e2e1f749069c45fab05898cd8d96647c512f1502fddb75444 |
|
MD5 | 74b0a907f4ba08275da115e920f02888 |
|
BLAKE2b-256 | 1549a15fc5f2a2189e73560c95b65537b93f3d9aefbe716d0cd520a3bc147454 |
Close
Hashes for pywpsrpc-2.3.7-cp310-cp310-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72e0ac19979aa7ff3d0c6663e6a2322b61f9586e5c700624f0fe2e0c1eca3471 |
|
MD5 | 85155658db142b2b35c1ca5354524344 |
|
BLAKE2b-256 | 7686d2feaa5d09575c4b125812a4fbbcce652fdf76480d75b9729ed0d873a1f5 |
Close
Hashes for pywpsrpc-2.3.7-cp39-cp39-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcd249b5d3d34e9066019f79bd9b8b5d18897c61f00e8211c4cb49aff6e9bf41 |
|
MD5 | bfbfcc0d8ddfcf57ee56deb139500fa2 |
|
BLAKE2b-256 | 214f60d8be77947359700bf34b9cc4c83c7975603781a7d039c65c72cbafb921 |
Close
Hashes for pywpsrpc-2.3.7-cp38-cp38-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 167fd4f704d782e07182a479e1a89f8af57df6f68b847c3115f1fbcc1ca6e161 |
|
MD5 | ae35d667447854f67eee3161cc152b9f |
|
BLAKE2b-256 | ce00cb7c99fec337ba5ea8983e5f2b723c2b0ce0dbc240626dd8c0ec46e3f8f2 |
Close
Hashes for pywpsrpc-2.3.7-cp37-cp37m-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bfa0f1b1db59ebbd4720abbfc8533dd3f33aab8102d488863600245f91f4099 |
|
MD5 | cdbb0c6ca54fd6371546f9510819086b |
|
BLAKE2b-256 | 788c337b6d38b07b49db932eeb812189140864258b78e2803e0c67530d4fe639 |
Close
Hashes for pywpsrpc-2.3.7-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce687ea0984a64c0ab60f4711cadd8292c5153cfe251168d894b632f6145da17 |
|
MD5 | 6705016a23116d8cec8e22f308ad56d4 |
|
BLAKE2b-256 | 405d788c37b2973f6ebf21baf265d8750908a17730d4958d48a97213e0748efc |