enderpy

Enderpy

Enderpy是Python的代碼完成引擎，靜態類型的Checker和語言服務器。

該項目正在積極發展。有破壞性的變化，除非您想為此做出貢獻並獲得樂趣，否則它沒有被認為可以使用。

enderpy.mp4

我為什麼需要它？

它為開發人員提供了快速的自動完成和快速反饋循環，撰寫Python時。

目標

拉夫表明，提供更快的靜態檢查器實現速度有一個價值。

該項目旨在建立實現快速自動完成和類型檢查的目標所需的組件，包括：

• Python Parser
• Python語義分析儀和類型檢查器
• Python語言服務器協議實施
• 用於解析和分析Python計劃的CLI

開發設置

克隆存儲庫

 git submodule init
git submodule update
cargo build

上述測試應無問題進行。

然後使用編輯客戶端。目前，支持的編輯是：

• Neovim
• VSCODE

貢獻

如果您在這裡，那麼您想編寫一些鏽蝕代碼，讓我們開始。您可以向我發送一條消息以進行討論/幫助。

您可以使用這些學習資源來了解項目的每個部分。

以下將是對項目及其工作原理的簡要介紹。但是，最好諮詢代碼以查看到底發生了什麼。

在編輯器中打開

VSCODE

1. 打開VSCODE
2. 導航到運行和調試選項卡
3. 選擇“啟動客戶端”並運行應用程序

默認情況下，擴展名使用enderpy-lsp命令運行語言服務器。要更改它，將SERVER_PATH Env變量設置為自定義可執行文件。

Neovim

將以下片段添加到您的init.lua文件中。

 -- Replace this ↓ with the actual path to your copy of the repository.
local enderpy_path = " /path/to/enderpy "
vim . api . nvim_create_autocmd ( " FileType " , {
  pattern = " python " ,
  callback = function ()
    vim . lsp . start ({
      name = " enderpy " ,
      cmd = { enderpy_path .. " /target/debug/enderpy-lsp " },
    })
  end ,
})

核心概念

該項目由多個板條箱組成，每個板條箱分別發布給板條箱：iio：

• 解析器：解析器和Lexer
• Typechecker：語義分析儀和鍵入檢查器
• Enderpy：與Lexer，解析器和類型檢查器互動的CLI
• LSP：LSP用於使用
• 客戶端：使用語言服務器的編輯客戶端

CLI和LSP是使用此項目的兩種方法。例如，當您在編輯器中使用Enderpy時，會發生這種情況：

1. 編輯器使用客戶端擴展程序連接到語言服務器
2. 語言服務器接收文本編輯事件，例如文件保存並發送它們以進行分析以進行診斷
3. Typechecker使用解析器來解析代碼（代碼首先通過Lexer，然後是Parer）並獲取AST
4. Typechecker運行語義分析通行證，然後運行類型檢查路徑
5. Typechecker將錯誤返回到語言服務器和語言服務器將其發送給編輯器
6. 編輯器向用戶顯示消息

測試

所有測試均使用insta.rs完成。

在每個板條箱中，您會找到一個稱為test_data的文件夾，其中包含其中的輸入。這些輸入是用於測試該板條箱的Python文件。例如，這是如何再次測試解析器的輸入：

enderpy/parser/src/parser/parser.rs

4A6F49D中的3695行

fn test_complete （ ） {

當測試使用Insta進行測試時，它們會產生可以查看的快照，並且保存這些快照後，它們將是測試的預期輸出。閱讀Insta.rs文檔，以查看如何運行和查看測試。

解析階段

解析階段是關於獲取Python源代碼並將其變成AST。

Lexer負責將Python源代碼施加。

解析器使用Lexer的輸出來讀取令牌並產生AST。

您可以使用CLI工具看到每個步驟的輸出（使用幫助查找如何使用它）。

還將結果與Python進行比較，您可以使用以下Python模塊：

• Tokenizer：https：//docs.python.org/3/library/tokenize.html
• AST：https：//docs.python.org/3/library/ast.html#ast.module

分析階段

分析階段首先獲得通往初始文件的路徑以輸入檢查。有一個名為Builder結構，可以管理從獲得途徑到創建診斷的所有內容。

Builder首先在初始文件中解析導入，並導入這些輸入以進行檢查。然後，它將在文件上進行第一次通過以綁定定義並將其存儲在符號表中。

項目使用訪問者模式來穿越AST。

Python有一個符號表，您可以使用該表來查看程序的符號表​​。 ./scripts文件夾中有一個腳本。

創建符號表之後，Bulider運行每個文件的Typecheck。

最後，構建器填充了列表中的錯誤。

用法

該項目可以通過兩種方式使用，首先是可以檢查您的Python項目的CLI工具，也可以用作編輯器內的LSP。

CLI

可用以下命令：

Usage: enderpy < COMMAND >

Commands:
  tokenize  Print lexer tokens
  parse     Print abstract syntax tree
  check     Type check
  symbols   Prints Symbol table
  help      Print this message or the help of the given subcommand(s)

LSP

對於LSP，您需要安裝enderpy-lsp程序，然後為編輯器安裝擴展程序。

LSP支持：

• 在文件中輸入檢查並顯示診斷消息

配置

當前沒有配置。這些是程序的默認行為。

項目根：被視為項目根的路徑。這會影響導入解決方案，並收集文件進行檢查。

Python可執行文件：Python可執行的路徑。這是為了解決第三方依賴。

受到啟發

• OXC
• 拉夫