PyRock

Sublime Text 生成 Python 导入语句的插件

功能

• 生成导入语句
• 复制导入语句
• 生成并复制 Django 或 pytest 支持的测试路径
• 运行 Django 或 pytest 测试
• 支持虚拟环境

即将推出

• 自动完成
• 项目级插件设置

安装

• 从 Sublime package control 安装包，输入名称 PyRock
• OR
• 从 Git 仓库克隆并将其放入您的 sublime packages 文件夹中

设置

{
    "paths_to_scan": [], // Not used as of now
    "python_venv_path": "",
    "python_interpreter_path": "", // Not used as of now
    "log_level": "info",
    "import_scan_depth": 4,
    "test_config": {
        "enabled": false, // Enable or disable run test feature, default false
        "test_framework": "", // django or pytest
        "working_directory": "", // Working directory of your project
        "test_runner_command": [], // Command to execute when clicking `Run as test`
    }
}

• paths_to_scan：仍处于开发中，目前无效。
• python_interpreter_path：仍处于开发中，目前无效。
• python_venv_path：指定索引文件时要使用的 Python 环境，未指定时将选择系统默认的 Python 解释器（确保您已设置默认 Python，否则它将无法索引）。它接受虚拟环境的 activate 文件的完整路径，例如

"python_venv_path": "/Users/abhishek/venv/bin/activate"

• log_level：默认为 info，接受的值为 info，debug，error，warning

• import_scan_depth：这定义了它将递归扫描 Python 包的深度，数字越高，扫描越深，4 是最佳深度，您可以增加它，但这也会增加索引所有文件的时间，所以请仔细更改。

• test_config.enabled

  • 说明：启用或禁用运行测试功能
  • 类型：str
  • 允许值: true 或 false
  • 默认值: false > ⚠️ 如果它设置为 false，则会忽略 test_config 中所有其他设置

• test_config.test_framework

  • 描述: 定义用于运行测试所使用的库
  • 类型：str
  • 允许值: django 或 pytest
  • 默认值: NA > ⚠️ 这假设 django 或 pytest 已在您的 python 环境中预先安装

• test_config.working_directory

  • 描述: 项目的当前工作目录，这将用于定义项目的根路径
  • 类型：str
  • 允许值: 有效路径
  • 默认值: NA

  • 示例:

    "working_directory": "/Users/abhishek/django-app/"
    

• test_config.test_runner_command

  • 描述: 点击 运行测试 时执行的命令
  • 类型: List[str]
  • 允许值: NA
  • 默认值: NA

  • 示例

    // For Django
    "test_runner_command": ["python", "manage.py", "test", "--keepdb"]
    
    // For Pytest
    "test_runner_command": ["pytest"]
    

用法

• 安装后，它将自动读取设置并扫描您的 python 环境以查找包并对它们进行索引。您将在状态栏中看到索引的进度，如下所示
  

• 由于某种原因，如果未发生索引或您想在移除/安装 python 环境中的包后重新索引，可以从命令面板调用“重新索引导入”，或者只需右键单击以打开菜单，然后在“PyRock”下您将看到“重新索引导入”
  

• 要生成 python 导入，请选择文本（至少 2 个字符），然后右键单击，在“PyRock”下点击“导入符号”，它将向您显示建议，从中选择任何一个，然后它将把该导入语句添加到您的 python 脚本中。

• 运行测试

  • 编写您的测试并保存为 test_*.py，文件名必须以 test_ 开头
  • 然后，当您保存时，将显示在单个测试类和方法上的 运行测试 注释，如果单击其中的任何一个，它将运行该特定测试 > 如果在运行过程中您想运行另一个测试，您可以简单地单击 运行测试，但这将结束任何正在运行的测试并启动新的测试。

快捷键

• 默认情况下，此插件禁用了快捷键，要启用它，您只需前往 首选项 -> 包设置 -> PyRock -> 快捷键，然后从左侧视图复制粘贴到您的右侧视图，取消注释它，或者您可以直接将以下内容复制到您的右侧视图并保存

[
  // Both of the key binding generate import statement suggestions for the selected text
  {
    "keys": ["super+shift+;"],
    "command": "py_rock",
    "args": { "action": "import_symbol" }
  },
  {
    "keys": ["ctrl+shift+;"],
    "command": "py_rock",
    "args": { "action": "import_symbol" }
  }
]

兼容性

• 需要 Sublime Text 版本 >= 4
• 仅为 Python 导入 提供
• 最佳体验与代码检查器支持 [可选]