根据代码注释限制在Thonny编辑器中的某些区域进行写入。
项目描述
thonny-sealed是Thonny IDE的一个插件,可以根据代码注释限制写入某些文本块。
这对于课堂练习等教学会话特别实用。教师准备练习,并使用特殊注释(例如# sealed: on 和 # sealed: off 或更直观的 # sealed: 🡻 和 # sealed: 🡹)标记“密封”块。
由于我们不希望学生在练习中意外引入新的密封块,因此通过使用内容哈希和它们的顺序进一步密封注释块。为此,插件提供了一个命令行工具thonny-seal。
内容被正确密封后,教师分发练习。学生使用已安装thonny-sealed插件的Thonny打开它们。密封块可以在编辑器中复制,但不能再修改。
安装
在Thonny中
插件可以通过 Thonny 容易地安装。转到 工具 菜单并选择 管理 插件...
在 PyPI 上搜索 thonny-sealed 并点击链接安装它
使用 pip
在您的虚拟环境中,调用
pip install --user thonny-sealed
用法
Thonny-sealed 根据特殊的注释检查文件中的代码块。用户被阻止编辑密封块内的内容。
使用注释行 # sealed: on 标记每个块的开始。类似地,使用 # sealed: off 标记密封块的结束。或者,您还可以使用更直观的注释 # sealed: 🡻 和 # sealed: 🡹 分别标记。
以下是一个示例文件
"""Provide some service."""
# sealed: on
def some_func() -> None:
"""Do something."""
# sealed: off
在已安装插件的终端中调用“seal”命令以使用哈希值密封块
thonny-seal --input path/to/the/file.py --write
您的文件现在已密封,可以在插件中加载。文件内容为
"""Provide some service."""
# sealed: on 3a9ff394
def some_func() -> None:
"""Do something."""
# sealed: off 3a9ff394
如果您不想覆盖文件,可以省略 --write 参数,将输出写入 STDOUT
thonny-sealed --input path/to/the/file.py
贡献
功能请求或错误报告总是非常受欢迎!
请快速查看 问题部分 中是否存在该问题,如果不存在,请创建 新问题。
您还可以通过代码进行贡献。请参阅 CONTRIBUTING.rst。
版本管理
我们遵循 语义版本控制。版本 X.Y.Z 表示
X 是主版本(向后不兼容),
Y 是次要版本(向后兼容),
Z 是补丁版本(向后兼容的bug修复)。
项目详情
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个,请了解有关 安装软件包 的更多信息。