gpt code commenter

gpt-code-kommentator

Dokumentieren Sie Code automatisch, indem Sie ihn an ein LLM (Chat-GPT) übergeben.

• Mit einer einfachen Eingabeaufforderung bitten wir den LLM, den angegebenen Code gemäß den Konventionen für diese Sprache zu kommentieren.

• NOTE : Dieses Tool erfordert weiterhin eine manuelle Überwachung: Wenn Sie die Ausgabe an denselben Speicherort zurückgeben, überprüfen Sie bitte die Ergebnisse, bevor Sie die Änderungen übernehmen. Standardmäßig gibt das Tool Ausgaben in stdout ODER in ein neues Verzeichnis aus.

• Anweisungen zur Einrichtung finden Sie im Abschnitt Setup weiter unten.

Verwendung

Hinweis: Die Skripte müssen im Ordner via-chat-gpt der obersten Ebene ausgeführt werden.

So kommentieren Sie eine einzelne Datei:

 pipenv run python via-chat-gpt  [--out-dir 
]

So kommentieren Sie Dateien in einem Verzeichnis (ist NICHT rekursiv):

 pipenv run python via-chat-gpt  [--out-dir 
] [--exclude ]

Hinweis: Um in dieselbe(n) Datei(en) zurückzuschreiben, geben Sie einfach --out-dir an, um auf dasselbe Verzeichnis zu verweisen. Überprüfen Sie dann jedoch bitte das Ergebnis, bevor Sie Änderungen vornehmen.

Beispiel

Generierte Beispieldokumentation (veröffentlicht über pdoc an S3): Cornsnake-Dokumentation.

EINGANG:

 import json

def read_from_json_file(path_to_json, encoding='utf-8'):
    with open(path_to_json, encoding=encoding) as f:
        data = json.load(f)
        return data

def write_to_json_file(dict, file_path, encoding='utf-8', indent=2):
    json_object = json.dumps(dict, indent=indent)

    with open(file_path, "w", encoding=encoding) as outfile:
        outfile.write(json_object)

AUSGABE:

 """
This Python file contains functions for reading from and writing to a JSON file. The `read_from_json_file` function reads JSON data from a file, and the `write_to_json_file` function writes JSON data to a file.
"""

import json

def read_from_json_file(path_to_json, encoding='utf-8'):
    """
    Function to read JSON data from a file.

    Args:
    path_to_json (str): The path to the JSON file.
    encoding (str): The encoding of the file. Default is 'utf-8'.

    Returns:
    dict: The JSON data read from the file.
    """
    with open(path_to_json, encoding=encoding) as f:
        data = json.load(f)  # Load JSON data from the file
        return data

def write_to_json_file(dict, file_path, encoding='utf-8', indent=2):
    """
    Function to write JSON data to a file.

    Args:
    dict (dict): The dictionary containing JSON data to be written.
    file_path (str): The path to the output JSON file.
    encoding (str): The encoding of the file. Default is 'utf-8'.
    indent (int): The number of spaces to indent the JSON data. Default is 2.
    """
    json_object = json.dumps(dict, indent=indent)  # Convert dictionary to JSON string with specified indent

    with open(file_path, "w", encoding=encoding) as outfile:
        outfile.write(json_object)  # Write JSON data to the file

Aufstellen

[EMPFOHLEN] Für openai (Remote-LLM):

 cd via-chat-gpt

Unix:

pip install pipenv
export PYTHONPATH= " ${PYTHONPATH} :. "
pipenv install

Windows:

pip install pipenv
set PYTHONPATH= " %PYTHONPATH% " ; .
pipenv install

Legen Sie die Umgebungsvariable mit Ihrem OpenAI-Schlüssel fest:

 export OPENAI_API_KEY= " xxx "

Fügen Sie das Ihrem Shell-Initialisierungsskript hinzu ( ~/.zprofile oder ähnlich)

Im aktuellen Terminal laden:

 source ~ /.zprofile

Testen Sie OpenAI

(cd via-chat-gpt)

test-openai.sh

oder

pipenv run python via-chat-gpt ../test-resources/util_json.py

Für phi2 (lokales LLM über llama-cpp-python) [UNIX ODER Windows] [EINFACHER ZU INSTALLIEREN]

• Ergebnisse sind nur OK (Chat-GPT hat viel bessere Ergebnisse)

• siehe via-phi2-the-bloke README

Für phi2 (lokales LLM über Transformer) [UNIX, nicht Windows] [SCHWIERIGER ZU INSTALLIEREN]

• TODO hat die Antwortverarbeitung für diese Version korrigiert

• siehe via-phi2 README