SublimeJEDI 使用教程

SublimeJEDI 使用教程

SublimeJEDIawesome Python autocompletion with SublimeText项目地址:https://gitcode.com/gh_mirrors/su/SublimeJEDI

本教程旨在帮助您快速理解和使用 SublimeJEDI 这一针对 Sublime Text 的 Python 开发插件。我们将依次介绍其关键的三个部分：项目目录结构、启动文件以及配置文件，以便您能够高效地集成并定制此工具。

1. 项目的目录结构及介绍

SublimeJEDI 的 GitHub 存储库遵循典型的 Python 包结构，以下是主要的目录和文件简述：

• .gitignore: 此文件定义了不应被 Git 版本控制系统跟踪的文件类型或模式。
• LICENSE: 许可证文件，说明了软件的使用条款，本项目采用的是Apache License 2.0。
• README.md: 快速入门指南和项目简介，包括安装步骤和其他重要信息。
• sublime_jedi: 主要的工作包，包含了实现插件功能的所有Python源代码。
  • __init__.py: 初始化模块，使得这个文件夹可以作为Python包导入。
  • 其他.py文件: 实现具体功能如完成、查找等。
• plugin.py: 插件的主要入口点，负责在Sublime Text中加载和初始化插件的各项功能。
• settings/Default.sublime-settings: 提供默认的设置示例，用于用户自定义配置的基础。

2. 项目的启动文件介绍

• plugin.py 是SublimeJEDI的核心启动文件。当Sublime Text加载该插件时，它首先执行此脚本。此文件负责初始化SublimeJEDI的所有核心服务和监听器，例如与JEDI交互的逻辑、自动完成的激活条件等。它确保插件在编辑器中正确运行，提供预期的Python开发辅助功能。

3. 项目的配置文件介绍

SublimeJEDI的配置主要是通过Sublime Text的用户设置来实现个性化调整。虽然配置文件直接操作是在用户的个人设置里，但初始配置参考位于：

• settings/SublimeJEDI.sublime-settings: 此文件提供了一组推荐或默认的配置选项。用户不需要直接修改此文件，而是应该在自己的 Preferences > Package Settings > SublimeJEDI > Settings - User 中复制并调整相应的设置项。

用户可能感兴趣的配置项包括：

• jedi_path: 指定JEDI库的路径（通常不需手动设置）。
• auto_complete_trigger: 控制自动补全触发的条件。
• show_docstring_in_popup: 是否在输入时显示文档字符串弹出提示。

通过上述介绍，您现在应该对SublimeJEDI的内部结构、启动流程以及如何进行个性化配置有了清晰的认识，能够更有效地利用这一工具提升您的Python编码体验。

SublimeJEDIawesome Python autocompletion with SublimeText项目地址:https://gitcode.com/gh_mirrors/su/SublimeJEDI