deoplete-jedi: Python完成源为Neovim的Deoplete插件教程
deoplete-jedideoplete.nvim source for Python项目地址:https://gitcode.com/gh_mirrors/de/deoplete-jedi
项目概述
deoplete-jedi 是一个专为 Neovim 设计的插件,它作为 Deoplete 的源来提供 Python 代码自动完成功能。该插件利用了 jedi 库来实现智能感知,极大地提升 Python 开发者在 Neovim 中的编码体验。
1. 项目目录结构及介绍
deoplete-jedi/
├── .gitattributes
├── .gitignore
├── .travis.yml # Travis CI 配置文件,用于自动化测试和部署
├── doc # 包含帮助文档,如 README.md
│ └── README.txt
├── plugin # Vim 插件主目录
│ └── deoplete_jedi.vim # 主插件脚本,负责整合 deoplete 和 jedi 功能
├── autoload # 自动加载脚本,提高 Vim 启动速度
│ └── deoplete_jedi.vim
├── runtime # 运行时路径,存放额外的脚本或数据文件
│ └── ftplugin # 文件类型插件特定配置
│ └── pythonx.vim # Python 文件类型的特殊处理
└── tests # 单元测试或集成测试脚本
└── ...
.gitattributes
,.gitignore
: 版本控制相关的配置,定义忽略文件和属性设置。.travis.yml
: 持续集成配置,用于自动化构建和测试。doc
: 包含主要的说明文档,用户了解插件特性和安装步骤的主要来源。plugin
和autoload
: 实现插件核心逻辑的地方,确保 Vim 启动快速且插件功能正常。runtime
: 提供文件类型特定的支持脚本,增强对Python文件的支持。tests
: 测试文件夹,用于开发过程中的测试代码。
2. 项目的启动文件介绍
虽然严格意义上没有单一的“启动文件”,但在实际使用中,安装配置完成后,启动 Neovim 并打开 Python 文件即可激活 deoplete-jedi
的功能。关键的交互发生于用户开启 Neovim 以及首次触发代码完成请求时,此时,deoplete-jedi.vim
在后台被调用,与 jedi 库协作提供完成建议。
3. 项目的配置文件介绍
全局配置示例
用户的 .vimrc
或 Neovim 的 init.vim
将是配置 deoplete-jedi 的主要位置:
" 安装并启用 deoplete-jedi
Plug 'deoplete-plugins/deoplete-jedi'
call deoplete#custom#set('sources',
\ {'python': ['deoplete-jedi']})
" 可选配置示例
let g:deoplete#sources#jedi#statement_length = 50 " 控制完成项描述长度
let g:deoplete#sources#jedi#enable_typeinfo = 1 " 开启类型信息显示
let g:deoplete#sources#jedi#enable_short_types = 0 " 使用完整类型而非简短类型
- 在使用插件管理器(如 Vim-Plug)时,上述配置确保了 deoplete-jedi 能够正确地被识别并配置。
g:deoplete#sources#jedi#...
配置项允许用户定制化插件的行为,例如调整完成项描述长度以适应自己的喜好,以及是否显示详细的类型信息等。
通过以上步骤和配置,开发者可以在 Neovim 中享受高效且智能化的 Python 编程环境。记得在安装插件后重启 Neovim 或执行相应命令使配置生效。
deoplete-jedideoplete.nvim source for Python项目地址:https://gitcode.com/gh_mirrors/de/deoplete-jedi