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.4.tar.gz
(6.1 MB
view hashes)
Built Distributions
Close
Hashes for pywpsrpc-2.3.4-cp311-cp311-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eea969e31562a75addef81aba47cbf48b622e7f6cae3cae40de8ae7d0c053f04 |
|
MD5 | 1f317d4450c3fb64770098ca28f20cea |
|
BLAKE2b-256 | 8adccd359e286e9c95c97c179a12b3c4cdcb8fefb7bcd7f8b26b0f09eb20ec30 |
Close
Hashes for pywpsrpc-2.3.4-cp310-cp310-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30d51ab9f729784be0ed461035bcfcabb248cbbaf8d823a9f460e02a471c6bb8 |
|
MD5 | 3caee6f9de3ccbbfc1e20af4c030b72d |
|
BLAKE2b-256 | 7673750ac4a92101dc4ff8eccfcbccec27a55cbf7ffa276e38ae429e23724714 |
Close
Hashes for pywpsrpc-2.3.4-cp39-cp39-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5fc839b0841d2aef2a2198e02cc1cdc3079d6b609cfb2ee680480cca1a72916 |
|
MD5 | cd43bcff148056531b39012243a223c1 |
|
BLAKE2b-256 | 46c60e32f31c55706e33dac2a41c61a0c8fe8f04e235ae739e629d6157b2dbf1 |
Close
Hashes for pywpsrpc-2.3.4-cp38-cp38-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1db22b5f636df4001b9c86f30bdb919358a59b512b35a642625065439fc7da5 |
|
MD5 | 2bce8530be9e40056353810e6000877d |
|
BLAKE2b-256 | d0f7fbdbbf222621d68ef81ce37ac4c924f40c8c9635969103a7af59ec02148c |
Close
Hashes for pywpsrpc-2.3.4-cp37-cp37m-manylinux_2_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f74eb910d948bd5e636662a5dbdc0a812e4e809fd04d25cb0c931942daf3b527 |
|
MD5 | 0cd0b2cdfc6bb95e85661778c150a3dc |
|
BLAKE2b-256 | 8ed8fd4349635009c4f03c4aab20632fa1e4fbb61a0048adbb19528e04d8bb52 |
Close
Hashes for pywpsrpc-2.3.4-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 257ec4b779ab01c23f8e2924412729fd24e1de6eb62a9135514f8005b2c6a09e |
|
MD5 | fd77b9b42288beff3ec9b6fcc8112bac |
|
BLAKE2b-256 | 7eb5049ebcd08f29333ea4467e5fffbf14f4f79b02d69689b37d9aa879829390 |