gpt code commenter

gpt-رمز-المعلق

قم بتوثيق الكود تلقائيًا عن طريق تمريره إلى LLM (Chat-GPT).

• من خلال مطالبة بسيطة، نطلب من LLM إضافة تعليق توضيحي للكود المحدد، مع اتباع الاصطلاحات الخاصة بتلك اللغة.

• NOTE - لا تزال هذه الأداة تتطلب إشرافًا يدويًا: في حالة الإخراج مرة أخرى إلى نفس الموقع، يرجى التحقق من النتائج قبل إجراء التغييرات. بشكل افتراضي، تقوم الأداة بالإخراج إلى stdout أو إلى دليل جديد.

• للحصول على تعليمات الإعداد، راجع قسم Setup أدناه.

الاستخدام

ملحوظة: يجب تشغيل البرامج النصية من داخل مجلد المستوى الأعلى via-chat-gpt .

للتعليق على ملف واحد:

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

للتعليق على الملفات في الدليل (ليست متكررة):

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

ملاحظة: للكتابة مرة أخرى إلى نفس الملف (الملفات)، ما عليك سوى تحديد --out-dir للإشارة إلى نفس الدليل. ولكن بعد ذلك يرجى التحقق من النتيجة قبل إجراء التغييرات.

مثال

تم إنشاء نموذج للوثائق (تم نشره عبر pdoc إلى S3): توثيق Cornsnake.

مدخل:

 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)

الإخراج:

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

يثبت

[موصى به] بالنسبة إلى openai (ماجستير في القانون عن بعد):

 cd via-chat-gpt

يونكس:

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

ويندوز:

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

قم بتعيين متغير البيئة باستخدام مفتاح OpenAI الخاص بك:

 export OPENAI_API_KEY= " xxx "

أضف ذلك إلى البرنامج النصي لتهيئة Shell ( ~/.zprofile أو ما شابه)

تحميل في المحطة الحالية:

 source ~ /.zprofile

اختبار OpenAI

(قرص مضغوط عبر الدردشة-GPT)

test-openai.sh

أو

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

بالنسبة إلى phi2 (LLM محلي عبر llama-cpp-python) [UNIX أو Windows] [أسهل في التثبيت]

• النتائج جيدة فقط (يحتوي Chat-GPT على نتائج أفضل بكثير)

• راجع التمهيدي عبر phi2-the-bloke

بالنسبة لـ phi2 (LLM محلي عبر المحولات) [UNIX وليس Windows] [أكثر صعوبة في التثبيت]

• TODO إصلاح معالجة الاستجابة لهذا الإصدار

• انظر التمهيدي عبر phi2