commentator

Kommentator

von Emery Berger

Commentator nutzt große Sprachmodelle, um dem Python-Code erläuternde Kommentare, Dokumentzeichenfolgen und Typen auf hoher Ebene hinzuzufügen.

Verwendung

Um zu funktionieren, muss Commentator mit einem lokalen KI-Dienst, einem OpenAI-Konto oder einem Amazon Web Services-Konto verbunden sein.

Lokaler KI-Dienst (Ollama)

Kommentator kann jetzt einen lokal installierten KI-Dienst nutzen; Es unterstützt derzeit Ollama. Um Ollama zu verwenden, installieren Sie es und legen Sie die Umgebungsvariable USE_OLLAMA fest:

  export USE_OLLAMA=1

OpenAI

Damit dies funktioniert, muss Ihr Konto über einen positiven Kontostand verfügen (überprüfen Sie Ihren OpenAI-Kontostand). Holen Sie sich hier einen OpenAI-Schlüssel.

Commentator verwendet derzeit standardmäßig GPT-4 und greift auf GPT-3.5-turbo zurück, wenn ein Anforderungsfehler auftritt. Damit das neueste und beste Modell (GPT-4) funktioniert, müssen Sie mindestens 1 $ an Credits erworben haben (wenn Ihr API-Konto vor dem 13. August 2023 erstellt wurde) oder 0,50 $ (wenn Sie ein neueres API-Konto haben).

Sobald Sie einen API-Schlüssel haben, legen Sie ihn als Umgebungsvariable mit dem Namen OPENAI_API_KEY fest.

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

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

Amazonas-Grundgestein

Commentator unterstützt jetzt Amazon Bedrock unter Verwendung des Claude-Modells. Um Bedrock verwenden zu können, müssen Sie drei Umgebungsvariablen festlegen.

 # 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

Wenn Sie noch keine Zugriffsschlüssel haben, sollten Sie diese erstellen können, indem Sie diesen Link mit Ihrem eigenen Benutzernamen und Ihrer Region ändern:

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

Sie müssen außerdem Zugriff auf Claude anfordern (Region nach Bedarf ändern):

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

Der Kommentator wählt automatisch aus, welcher KI-Dienst verwendet werden soll (lokal, OpenAI oder AWS Bedrock), wenn er erkennt, dass die entsprechenden Umgebungsvariablen festgelegt wurden.

Commentator verwendet einen Pfad zu einer Python-Datei und einen optionalen Sprachparameter. Wenn eine Sprache angegeben ist, übersetzt Commentator jede Dokumentzeichenfolge und jeden Kommentar im Code in die angegebene Sprache. Die Standardsprache ist Englisch.

Installation

Um Commentator zu installieren, können Sie pip verwenden:

 $ pip install python-commentator

Beispiel

Angenommen, Sie haben eine Datei namens example.py mit dem folgenden Code:

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

Führen Sie Commentator für diese Datei aus, um Kommentare hinzuzufügen und Anmerkungen einzugeben:

 $ commentator example.py

Der resultierende Code könnte sein:

 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

Beachten Sie, dass Commentator eine Dokumentzeichenfolge und Typanmerkungen hinzugefügt hat.