Skip to content

Latest commit

 

History

History
executable file
·
131 lines (86 loc) · 5.95 KB

readme.md

File metadata and controls

executable file
·
131 lines (86 loc) · 5.95 KB
Raw

sigil-console

sigil-console 是一个 Sigil 插件，可以在控制台中交互式地输入并运行 python 代码。利用 Sigil 提供的 python 接口，可以读写当前正在用 Sigil 操作的 ePub 书。

配置

运行插件后，只要当前的 python 执行环境的 tkinter 模块可用，则会弹出如下的配置界面。

如果用鼠标在上面的配置界面中的一些地方悬停几秒，就会弹出相应的提示说明，你可以通过阅读这些提示说明，来了解如何进行配置。
配置完成后，直接关闭配置界面的窗口，就会生效。

基本操作

1. 选择并进入 console

在配置界面中选择一个特定的 console 后，关闭窗口，就会自动打开对应的 console。

我个人推荐你选择 ipython，后面的示例代码我都会用 ipython 执行。

如果没有自动加载环境，就需要你手动加载。你也可以在 console 中运行一个 sigil_console_startup.py 文件，来加载环境。sigil_console_startup.py 文件的路径如下图（每一次运行插件后，路径都不同）：

2. 退出 console

退出需要运行专门的命令，直接关闭窗口可能会丢弃修改。
所有的 console 中，你都可以通过运行（输入后回车） exit、exit() 或 plugin.exit() 命令退出。
有些支持输入 Ctrl-D 或 Ctrl-Q 组合键退出。但在 idle* 和 euporie 下，会丢弃修改。
jupyter lab 和 jupyter notebook 打开后，会先打开一个命令行终端，再在终端运行一个网页服务，你写代码是在网页上，但需要在命令行终端输入 Ctrl-C 退出。

3. 运行命令

在命令行中输入 python 代码或命令，回车后就会运行。这里所谓的命令行，运行着上面提到的某个 console，并有着一种称为 REPL 的运行方式，提供了一种反复地【输入-运行-输出】的交互式工作流程。

下图展示了，在 ipython console 中运行了几个命令：

4. 调用 Sigil 的 python 接口

具体有哪些接口，可参考文档 Routines to Access and Manipulate OPF elements，你可以在 bc 或者 bk 上调用这些接口，bc 和 bk 是同一个东西，只是名字不同，你可以根据喜好选用其一。

In [1]: bc
Out[1]: <bookcontainer.BookContainer at 0x108c41fc0>

In [2]: bk
Out[2]: <bookcontainer.BookContainer at 0x108c41fc0>

In [3]: list(bc.text_iter())
Out[3]: [('Section0001.xhtml', 'Text/Section0001.xhtml')]

5. plugin.*

我提供了很多帮助函数，作为全局变量 plugin 的属性提供，可阅读来了解文档，也可以用 help() 函数来查看说明文档。

6. editor.*

我提供了很多便于操作 ePub 的函数，作为全局变量 editor 的属性提供，可阅读来了解文档，也可以用 help() 函数来查看说明文档。

7. 安装和删除模块

当前的 python 环境中有 pip 时，可以使用 plugin.install() 函数安装第三方模块，plugin.uninstall() 函数删除第三方模块。

使用实例

详细资料，请参考 官方文档。

1. 添加和删除文件

  1. 运行下面的命令，可以在当前正在操作的 ePub 书中添加一个 id 和 名字 为 Sectionxxxx.xhtml 的文件：
text = '''<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title></title>
</head>

<body>
  <p>&nbsp;</p>
</body>
</html>'''

fileid = filename = 'Sectionxxxx.xhtml'
# 可以省略 mime 参数，如此会自动根据后缀名判断 mimetype
bc.addfile(fileid, filename, text, mime='application/xhtml+xml')
  1. 运行下面的命令，可以删除一个 id 为 Sectionxxxx.xhtml 的文件：
bc.deletefile('Sectionxxxx.xhtml')

2. 读写文件

  1. 运行下面的命令，可以读取一个 id 为 Sectionxxxx.xhtml 的文件内容：
bc.readfile('Sectionxxxx.xhtml')
  1. 运行下面的命令，可以修改一个 id 为 Sectionxxxx.xhtml 的文件内容：
text = '''<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title></title>
</head>

<body>
  <p>&nbsp;</p>
</body>
</html>'''

bc.writefile('Sectionxxxx.xhtml', text)