gpt code commenter

gpt-kode-komentator

Dokumentasikan kode secara otomatis dengan meneruskannya ke LLM (Chat-GPT).

• Dengan perintah sederhana, kami meminta LLM untuk memberi anotasi pada kode yang diberikan, mengikuti konvensi untuk bahasa tersebut.

• NOTE - alat ini masih memerlukan pengawasan manual: Jika mengeluarkan kembali ke lokasi yang sama, harap periksa hasilnya sebelum melakukan perubahan. Secara default, alat ini menghasilkan stdout ATAU ke direktori baru.

• untuk petunjuk pengaturan, lihat bagian Setup di bawah.

Penggunaan

catatan: skrip harus dijalankan dari dalam folder via-chat-gpt tingkat atas.

Untuk mengomentari satu file:

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

Untuk mengomentari file dalam direktori (TIDAK rekursif):

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

catatan: untuk menulis kembali ke file yang sama, cukup tentukan --out-dir untuk menunjuk ke direktori yang sama. Namun harap periksa hasilnya sebelum melakukan perubahan.

Contoh

Contoh dokumentasi yang dihasilkan (diterbitkan melalui pdoc ke S3): dokumentasi cornsnake.

MASUKAN:

 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)

KELUARAN:

 """
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

Pengaturan

[DIANJURKAN] Untuk openai (LLM jarak jauh):

 cd via-chat-gpt

Unix:

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

jendela:

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

Tetapkan variabel lingkungan dengan kunci OpenAI Anda:

 export OPENAI_API_KEY= " xxx "

Tambahkan itu ke skrip inisialisasi shell Anda ( ~/.zprofile atau serupa)

Muat di terminal saat ini:

 source ~ /.zprofile

Uji OpenAI

(cd via-chat-gpt)

test-openai.sh

atau

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

Untuk phi2 (LLM lokal melalui llama-cpp-python) [UNIX ATAU Windows] [LEBIH MUDAH DIINSTAL]

• Hasilnya hanya OK (Chat-GPT memberikan hasil yang jauh lebih baik)

• lihat melalui-phi2-the-bloke README

Untuk phi2 (LLM lokal melalui trafo) [UNIX bukan Windows] [LEBIH SULIT UNTUK DIINSTAL]

• TODO memperbaiki penanganan respons untuk versi ini

• lihat via-phi2 README