commentator

評論員

作者：埃默里‧伯傑

Commentator 利用大型語言模型為 Python 程式碼添加高階解釋性註解、文件字串和類型。

用法

為了運作，Commentator 需要連接到本機 AI 服務、OpenAI 帳戶或 Amazon Web Services 帳戶。

本地AI服務（Ollama）

評論員現在可以使用本地安裝的AI服務；目前支援Ollama。要使用 Ollama，請安裝它並設定環境變數USE_OLLAMA ：

  export USE_OLLAMA=1

開放人工智慧

您的帳戶需要有正餘額才能發揮作用（檢查您的 OpenAI 餘額）。在此處取得 OpenAI 金鑰。

Commentator 目前預設為 GPT-4，如果發生請求錯誤，則回退到 GPT-3.5-turbo。要使最新、最佳模型(GPT-4) 正常工作，您需要購買至少1 美元的積分（如果您的API 帳戶是在2023 年8 月13 日之前創建的）或0.50 美元（如果您有較新的API 帳戶）。

取得 API 金鑰後，將其設定為名為OPENAI_API_KEY的環境變數。

 # On Linux/MacOS:
export OPENAI_API_KEY= < your-api-key >

# On Windows:
$env :OPENAI_API_KEY= < your-api-key >

亞馬遜基岩

Commentator 現在使用 Claude 模型支援 Amazon Bedrock。要使用 Bedrock，您需要設定三個環境變數。

 # On Linux/MacOS:
export AWS_ACCESS_KEY_ID= < your-access-key >
export AWS_SECRET_ACCESS_KEY= < your-secret-key >
export AWS_REGION_NAME=us-west-2

如果您還沒有存取密鑰，您應該可以透過使用您自己的使用者名稱和區域修改此連結來建立它們：

 https://us-east-1.console.aws.amazon.com/iam/home?region=us-east-1#/users/details/YOUR_USER_NAME?section=security_credentials

您還需要請求訪問 Claude（根據需要更改區域）：

 https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/modelaccess

當 Commentator 偵測到已設定適當的環境變數時，將自動選擇要使用的 AI 服務（本地端、OpenAI 或 AWS Bedrock）。

Commentator 採用 Python 檔案的路徑和可選的語言參數。如果指定了語言，Commentator 會將程式碼中的每個文件字串和註解翻譯為指定的語言。預設語言是英語。

安裝

要安裝 Commentator，您可以使用 pip：

 $ pip install python-commentator

例子

假設您有一個名為example.py的文件，其中包含以下程式碼：

 def absolutely(n):
    if n < 0:
        return -n
    else:
        return n

對此文件執行 Commentator 以新增註解並鍵入註解：

 $ commentator example.py

結果代碼可能​​是：

 def absolutely(n: int) -> int:
    """
    Return the absolute value of a number.
    
    Args:
    - n (int): the number whose absolute value we want to find
    
    Returns:
    - int: the absolute value of n
    """
    if n < 0:
        # If n is negative
        # Return the negative version of n (i.e. its absolute value)
        return -n
    else:
        # Otherwise (if n is non-negative)
        # Return n as-is (it already is its absolute value)
        return n

請注意，Commentator 新增了文件字串和類型註解。