PDFreactor配置解析器
项目描述
此软件包提供对由pdfreactor-api软件包提供的PDFreactor客户端API的解析功能。
要有效使用它，您需要
运行PDFreactor服务器
一些与您的框架集成的PDFreactor；当使用Plone时，您可以使用pdfreactor.plone软件包。
功能
一个parse_configuration函数
在Plone环境中，一个pdfreactor-config浏览器视图，以便基本使用它，即从
存储在Plone注册表中的全局文本转换配置中生成一个config字典。
一个自定义的@@pdfreactor-conversion-settings表单
注意：尽管许可证密钥（除非，如建议的那样，安装在服务器上）需要放入config字典中，但我们将其视为连接相关的，因此我们不会期望您将其放入您的转换配置中。
您可以这样操作（指定为单个字符串标记），例如，我们的pdfreactor.plone软件包在IPdfReactorConnectionSettings接口中提供了一个专门的设置。
示例
文本配置可能如下所示
# line comments are possible
outputFormat = {
width: 640, # and so are end-of-line comments
type: OutputType.PNG_TRANSPARENT,
}
由PDFreactor API类定义的符号被识别，因此这将转换为以下config字典
{'outputFormat': {
'width': 640,
'type': 'PNG_TRANSPARENT',
}
}
这看起来并不神奇，但它可以帮你避免为每个可能的键找到保存设置的方法；你只需要一个配置字符串。
在值方面，我们只接受有效的配置符号（区分大小写，所以 OutputType.png_transparent 会引发错误）或有效的 Python 字符串或数字标记；为了方便，接受对 true、false 和 nothing 的几个常见名称（不区分大小写）。
局限性
我们仍然在处理能力上有所限制；例如，对于样式表，API 预期的是“对象”（在 JSON 术语中；Python：字典），而不仅仅是 URI。目前，我们接受字符串作为 URI 规范。
integrationStyleSheets = ['++resource++pdfreactor.plone/export.css']
转换为
{'integrationStyleSheets': [{
'uri': '++resource++pdfreactor.plone/export.css'
}]
}
API 方法转换
我们还提供了一个（仍然是不完整和/或实验性的 – “自行承担风险”）转换函数，允许您将 API 调用转换为 PDFreactor v7 之前使用的格式；例如
enableDebugMode()
将转换为这个 config 值
{'debugSettings': {'appendLogs': True}}
默认情况下不会这样做；使用
from pdfreactor.parsecfg.oldmethods import convert_api_method parse_configuration(..., convert=convert_api_method)
来使其发生。
文档
安装
只需使用 pip 安装配置解析器
pip install pdfreactor.parsecfg
或者，对于使用 buildout 的项目，将其添加到您的 buildout.cfg 脚本中
[buildout]
...
eggs =
pdfreactor.parsecfg
然后运行 bin/buildout。
这将为您提供 pdfreactor-api 包。
重启您的 Zope 实例后，您将在快速安装器或 Plone 扩展组件视图中找到该包。
Plone 集成
在将 pdfreactor.parsecfg（以及可能的 pdfreactor.plone）添加到您的 eggs 后重启您的 Zope 实例，只需使用 Plone 扩展组件视图或快速安装器即可激活它。
然后您可以使用配置注册表，并使用 IPdfReactorConversionSettings 前缀来调整您的转换首选项。
注意： 此包关于配置解析，不是主要关于 Zope / Plone。要使 PDFreactor 网络服务使用您的实际会话 cookie，请同时使用 pdfreactor.plone。
可能值
对于将被 PDFreactor 后端识别的值，请参阅 RealObjects GmbH 的文档。
例如，如果 debugSettings 模型的文档 介绍了布尔属性 appendLogs、attachConfiguration、attachDocuments、attachResources、forceResult 和 all，这意味着您可以配置例如
debugSettings.all = on
或
debugSettings = {
appendLogs: yes,
forceResult: true,
}
其他包
pdfreactor-api，所需的 API 分发包
支持
如果您在使用此配置解析器时遇到问题，请告诉我们；请使用以下提到的 问题跟踪器。
有关 PDFreactor 自身的问题，请参阅 RealObjects GmbH。
贡献
（到这个配置解析器包：）
许可证
该项目采用 MIT 许可证。
变更日志
1.0.1 (2023-01-20)
错误修复
对于 userScripts，我们还需要创建带有 'uri' 键的字典。
其他
已删除过时的文件和目录
[tobiasherp]
1.0.0 (2022-07-12)
初始发布。[tobiasherp]
pdfreactor.parsecfg-1.0.1.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 28c42af8548f41a1d80475bd8c5170b7a79ef989ec2d50cad0e9bc8018ea14a9 |
|
| MD5 | 33c772e651e642182ce952fe4f063904 |
|
| BLAKE2b-256 | 3f91efaeb883b3ae2824f74a6ae332943cf4def1b81892d89f532e4a8e7f7811 |
